build: upgrade docs to sphinx stack 2 - #608
Draft
raimundo-henriques wants to merge 1 commit into
Draft
raimundo-henriques wants to merge 1 commit into
raimundo-henriques wants to merge 1 commit into
Conversation
Upgrades the docs from v1.4 to v2, covering: - tooling layout; - dependency updates; - Read the Docs warning policy; - redirct migration; and - support for llms-txt.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The documentation did not provide an llms.txt index, which hindered LLM-based tools from discovering and navigating Snap documentation reliably.
Solution
Upgrade to v2 of the Sphinx Stack, which, among other things, provides support for llms.txt out of the box.
Notes on implementation
/llms.txtis not accessible from the preview deployment (returns a 403); this is due to a recent change from RTD and a known limitation; it is being generated and should be served once these changes are merged./docs/is part of the base URL and yet the preview deployment serves the docs under/.