feat(docs): improve discoverability of API reference docs#22425
Open
critesjosh wants to merge 2 commits intonextfrom
Open
feat(docs): improve discoverability of API reference docs#22425critesjosh wants to merge 2 commits intonextfrom
critesjosh wants to merge 2 commits intonextfrom
Conversation
Add static API docs to sitemap, Typesense search index, and LLM context files so they are findable via search engines, site search, and AI tools.
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
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
augment_sitemap.jspost-build script injects Aztec.nr API HTML URLs intositemap.xml, making them visible to search engine crawlers (Docusaurus only indexes its managed routes)api-nr) tuned fornargo docHTML structure, enabling site search to surface API reference resultsappend_api_docs_to_llms.jsto also include TypeScript API markdown docs inllms.txt/llms-full.txt, with format-aware processing (markdown passthrough vs HTML-to-text conversion)Test plan
yarn buildcompletes successfully in docs/build/sitemap.xmlcontainsaztec-nr-api/URLs after buildbuild/llms.txtcontains both Aztec.nr and TypeScript API sections🤖 Generated with Claude Code