fix(docs): correct llms.txt links for versioned developer docs#22819
Merged
critesjosh merged 1 commit intonextfrom May 4, 2026
Merged
fix(docs): correct llms.txt links for versioned developer docs#22819critesjosh merged 1 commit intonextfrom
critesjosh merged 1 commit intonextfrom
Conversation
Bump docusaurus-plugin-llms to 0.4.0 and update its config so the generated llms.txt and llms-full.txt produce correct URLs under /developers/... for the current versioned developer docs: - Drop trailing slash on docsDir so the plugin can strip the version prefix when matching files against Docusaurus routes. - Set addMdExtension: false (site serves HTML, not .md). - Update pathTransformation for the fallback URL builder so the versioned-docs prefix is removed and /developers is prepended.
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
alejoamiras
approved these changes
May 3, 2026
AztecBot
pushed a commit
that referenced
this pull request
May 4, 2026
## Summary Fix broken links in the autogenerated `llms.txt` and `llms-full.txt` files produced by `docusaurus-plugin-llms`. - Bump `docusaurus-plugin-llms` from `^0.2.0` to `^0.4.0` to use route-based URL resolution. - Drop trailing slash on `docsDir` so the plugin can correctly strip the versioned-docs prefix when matching files against Docusaurus routes. - Set `addMdExtension: false` since the site serves HTML, not raw `.md`. - Update `pathTransformation` (used as fallback) to ignore the versioned-docs path and prepend `developers` so URLs resolve to `https://docs.aztec.network/developers/...`. ## Test plan - [x] `yarn build` produces `build/llms.txt` and `build/llms-full.txt` - [x] All entries in `llms.txt` use `https://docs.aztec.network/developers/...` - [x] No `developer_versioned_docs` or `version-vX.Y.Z` segments leak into URLs - [x] No `.md` suffixes on generated links - [x] Spot-checked a sample link (`/developers/docs/aztec-js/aztec_js_reference`) returns 200
Collaborator
|
✅ Successfully backported to backport-to-v4-next-staging #22924. |
AztecBot
added a commit
that referenced
this pull request
May 5, 2026
BEGIN_COMMIT_OVERRIDE docs: add map and state variable docs (#22824) fix: e2e compat should not fail for contracts added after legacy stables (#22900) chore: fix kv-store browser tests hangs (#22721) feat: kv-store sqlite backend with page level encryption (#22759) fix: install node 22 for aztec-cli acceptance test (#22917) feat: backport kv-store sqlite encryption (#22759) to v4-next (#22927) fix(docs): correct llms.txt links for versioned developer docs (#22819) feat(docs): improve discoverability of Aztec.nr API reference docs (#22861) feat(docs): backport improve discoverability of Aztec.nr API reference docs (#22861) to v4-next (#22931) feat(aztec-nr): add call_self stubs for utility functions (#22885) docs: add map and state variable docs (backport #22824) (#22880) refactor: `getPackageVersion` fn cleanup (#22941) fix(ci): skip acceptance test for canary -commit. tags (#22951) fix: closing db, correct stub side effects (#22939) END_COMMIT_OVERRIDE
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
3 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.
Summary
Fix broken links in the autogenerated
llms.txtandllms-full.txtfiles produced bydocusaurus-plugin-llms.docusaurus-plugin-llmsfrom^0.2.0to^0.4.0to use route-based URL resolution.docsDirso the plugin can correctly strip the versioned-docs prefix when matching files against Docusaurus routes.addMdExtension: falsesince the site serves HTML, not raw.md.pathTransformation(used as fallback) to ignore the versioned-docs path and prependdevelopersso URLs resolve tohttps://docs.aztec.network/developers/....Test plan
yarn buildproducesbuild/llms.txtandbuild/llms-full.txtllms.txtusehttps://docs.aztec.network/developers/...developer_versioned_docsorversion-vX.Y.Zsegments leak into URLs.mdsuffixes on generated links/developers/docs/aztec-js/aztec_js_reference) returns 200