Skip to content

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
codex/create-comprehensive-markdown-documentation-for-kinu
Open

docs: generate exhaustive LLM reference and publish to docs/demo#97
developit wants to merge 1 commit intocodex/rename-project-from-pui-to-kinu-0ljlqsfrom
codex/create-comprehensive-markdown-documentation-for-kinu

Conversation

@developit
Copy link
Copy Markdown
Owner

Motivation

  • Provide a single, machine-friendly, source-of-truth reference that enables LLM coding agents to understand every kinu component, what HTML element it enhances, and the kinu-specific props they should consider.
  • Make the llms.txt artifact repeatable and always in sync with source by integrating generation into the existing docs pipeline rather than maintaining a hand-authored file.
  • Surface typed prop information and element mappings so agents can infer native DOM attributes/events and produce high-signal code suggestions.

Description

  • Extended scripts/generate-docs.mjs to extract component exports, element mappings, and typed props from source/types and to emit a comprehensive docs/llms.txt document and a demo copy at demo/public/llms.txt, plus a landing page at docs/pages/llms.md.
  • Enhanced the generator to return per-component metadata (exports, prop tables, attachments) and to format a machine-oriented reference that lists purpose, usage, enhanced HTML element(s), and kinu-specific props for each export.
  • Updated docs navigation and artifacts by adding an LLM Integration Reference entry in docs/metadata.mjs and regenerating component markdown and docs/manifest.json so the new page appears in the site; also adjusted a few generated component pages to include the new details.
  • Added a convenience npm script docs:generate to package.json so the full docs/llms generation is repeatable (node scripts/generate-docs.mjs).

Testing

  • Ran pnpm docs:generate which completed successfully and produced docs/llms.txt, demo/public/llms.txt, docs/pages/llms.md, and regenerated component docs.
  • Ran pnpm lint (TypeScript + biome), which completed with no errors.
  • Ran pnpm test (Vitest), which passed the test suite (1 test).

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant