Skip to content

feat(docs): make docs more agent friendly#475

Open
tharropoulos wants to merge 12 commits into
typesense:masterfrom
tharropoulos:llms-txt
Open

feat(docs): make docs more agent friendly#475
tharropoulos wants to merge 12 commits into
typesense:masterfrom
tharropoulos:llms-txt

Conversation

@tharropoulos
Copy link
Copy Markdown
Collaborator

Change Summary

  • preserve frontmatter in generated markdown instead of stripping it
  • add description frontmatter to overview pages
  • add description frontmatter to guide pages
  • add description frontmatter to latest API reference pages for 30.1
    and 30.2
  • emit per-language .md variants for pages with tabbed code samples for the latest two versions
  • generate llms.txt with grouped documentation links, page descriptions, latest version info, language-variant guidance, and the OpenAPI spec link
  • generate llms-full.txt by concatenating cleaned markdown content from docs pages
  • warn when llms-full.txt exceeds 2 MB
  • prepend a visible llms.txt hint to served markdown responses
  • inject a hidden llms.txt hint into rendered docs pages after MarkdownActions

PR Checklist

@tharropoulos tharropoulos requested a review from jasonbosco May 15, 2026 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant