docs: generate exhaustive LLM reference and publish to docs/demo#97
Open
developit wants to merge 1 commit intocodex/rename-project-from-pui-to-kinu-0ljlqsfrom
Conversation
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.
Motivation
llms.txtartifact repeatable and always in sync with source by integrating generation into the existing docs pipeline rather than maintaining a hand-authored file.Description
scripts/generate-docs.mjsto extract component exports, element mappings, and typed props from source/types and to emit a comprehensivedocs/llms.txtdocument and a demo copy atdemo/public/llms.txt, plus a landing page atdocs/pages/llms.md.LLM Integration Referenceentry indocs/metadata.mjsand regenerating component markdown anddocs/manifest.jsonso the new page appears in the site; also adjusted a few generated component pages to include the new details.docs:generatetopackage.jsonso the full docs/llms generation is repeatable (node scripts/generate-docs.mjs).Testing
pnpm docs:generatewhich completed successfully and produceddocs/llms.txt,demo/public/llms.txt,docs/pages/llms.md, and regenerated component docs.pnpm lint(TypeScript +biome), which completed with no errors.pnpm test(Vitest), which passed the test suite (1 test).Codex Task