-
Notifications
You must be signed in to change notification settings - Fork 230
[Docs] Update docs home page section on gen AI Assistance #1517
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the Vizro documentation home page to add a deprecation notice for Vizro-AI and introduces links to llms.txt and llms-full.txt files for AI/LLM consumption of the documentation.
Key changes:
- Added "(deprecated)" label to the Vizro-AI link
- Added two new links to
llms.txtandllms-full.txtfiles, both pointing to the stable version
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
View the example dashboards of the current commit live on PyCafe ☕ 🚀Updated on: 2025-12-08 12:25:10 UTC Compare the examples using the commit's wheel file vs the latest released version: vizro-core/examples/scratch_devView with commit's wheel vs View with latest release vizro-core/examples/dev/View with commit's wheel vs View with latest release vizro-core/examples/visual-vocabulary/View with commit's wheel vs View with latest release vizro-core/examples/tutorial/ |
Co-authored-by: Copilot <[email protected]>
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
Description
llms.txtandllms-full.txtto make it possible to find them (if you're human, AI should be OK).The
llms-full.txtisn't yet built for stable as it's only recently been enabled in settings which aren't yet released yet (next Vizro release will fix that). The docs will be fine when this is merged though, since they'll show onlatestwhich does havellms-full.txt, so the link will work there.Worth noting that we are versioning our links so there's a
llms.txtfor every version since we started building it e.g. https://vizro.readthedocs.io/en/0.1.47/llms.txt (and from 0.1.49 there will also bellms-full.txt).But we can only link to one from the front page, so I've used the
stableversion (which == the current release) and labelled it in the link text.BUILT DOCS ARE HERE
Screenshot
Notice
I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":