Skip to content

Conversation

@stichbury
Copy link
Contributor

@stichbury stichbury commented Dec 5, 2025

Description

  • Add a deprecation notice on the Vizro-AI docs
  • Add links to llms.txt and llms-full.txt to make it possible to find them (if you're human, AI should be OK).
image

The llms-full.txt isn'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 on latest which does have llms-full.txt, so the link will work there.

Worth noting that we are versioning our links so there's a llms.txt for 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 be llms-full.txt).

But we can only link to one from the front page, so I've used the stable version (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":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

@stichbury stichbury self-assigned this Dec 5, 2025
Copilot AI review requested due to automatic review settings December 5, 2025 13:29
@stichbury stichbury added the Docs 🗒️ Issue for markdown and API documentation label Dec 5, 2025
Copilot finished reviewing on behalf of stichbury December 5, 2025 13:31
Copy link
Contributor

Copilot AI left a 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.txt and llms-full.txt files, both pointing to the stable version

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 5, 2025

View the example dashboards of the current commit live on PyCafe ☕ 🚀

Updated on: 2025-12-08 12:25:10 UTC
Commit: 1efe90f

Compare the examples using the commit's wheel file vs the latest released version:

vizro-core/examples/scratch_dev

View 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/

View with commit's wheel vs View with latest release

@stichbury stichbury merged commit 36203c2 into main Dec 8, 2025
53 of 54 checks passed
@stichbury stichbury deleted the docs/update-home-page branch December 8, 2025 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs 🗒️ Issue for markdown and API documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants