Skip to content

docs: add llms.txt router for LLM/agent navigation#5

Open
gregogun wants to merge 1 commit into
newcore-network:masterfrom
gregogun:feat/add-llms-txt
Open

docs: add llms.txt router for LLM/agent navigation#5
gregogun wants to merge 1 commit into
newcore-network:masterfrom
gregogun:feat/add-llms-txt

Conversation

@gregogun

Copy link
Copy Markdown

Summary

Adds a static llms.txt at the site root to help LLMs and coding agents navigate the OpenCore documentation.

It follows the shadcn/ui llms.txt convention — a title, a one-line blockquote summary, and sectioned markdown links — acting as a router into the docs rather than dumping full content.

Details

  • Lives at static/llms.txt, so Docusaurus serves it at https://opencorejs.dev/llms.txt.
  • Link ordering mirrors sidebars.ts top to bottom, including nested categories (Communication → Events/RPC/Binary/Exports, Gameplay → Entities/Server APIs/Client APIs, etc.).
  • All 124 links map to existing doc pages — verified against sidebars.ts (adapters/index correctly resolves to /docs/adapters).
  • Descriptions use each page's frontmatter description where present, with concise summaries elsewhere. Duplicate decorator names are disambiguated with (Server)/(Client).

🤖 Generated with Claude Code

Add a static llms.txt at the site root listing all documentation
pages, ordered to match sidebars.ts. Follows the shadcn/ui llms.txt
convention (title + blockquote, sectioned markdown links). Every
link maps to an existing doc page.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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