docs: add llms.txt, page descriptions, and edit links - #4037
Open
Giri-Aayush wants to merge 1 commit into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4037 +/- ##
==========================================
- Coverage 79.31% 79.18% -0.14%
==========================================
Files 464 464
Lines 35793 35787 -6
==========================================
- Hits 28389 28337 -52
- Misses 7395 7441 +46
Partials 9 9 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
Do you have the docs traffic by chance? |
rodrodros
reviewed
Sep 5, 2026
Contributor
There was a problem hiding this comment.
This file should maybe have unit tests?
Comment on lines
+50
to
54
| // Edit links point at docs/ (next) so fixes land where they flow forward. | ||
| editUrl: "https://github.com/NethermindEth/juno/edit/main/docs/", | ||
| editCurrentVersion: true, | ||
| showLastUpdateTime: true, | ||
| }, |
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
2 participants
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.
Make the docs readable by agents and findable by search.
Reason
Most of our docs traffic is agents, and today they get nothing built for them: no llms.txt, no raw markdown, no page descriptions. This adds an llms.txt index, an
llms-full.txt, and a raw.mdbeside every page (served astext/markdown), generated on every build from the published version. The same one-line description per page feeds both the llms.txt index and the HTML meta tag search engines quote. Also adds edit links, real last-updated dates, and a robots.txt.