Skip to content

add llms.txt and llm-full.txt docs #206

Description

@pablofullana

User story / Problem statement

Currently docs.dappbooster.cc serves only the typedoc HTML reference. A coding agent, or an LLM-backed editor that wants the kit's docs, has to scrape the pages or be pointed at them by hand. M1 asks for agentic-ready documentation, and there is no plain-text entry a model can read.

Expected outcome

docs.dappbooster.cc serves two files a model can read as-is: /llms.txt, a short markdown index of the docs with links, and /llms-full.txt, the whole reference in one file to paste at once. The build writes both, so they cannot fall behind the reference.

Acceptance criteria

  • docs:build writes /llms.txt and /llms-full.txt into the typedoc output
  • /llms.txt carries the kit blurb and links to getting started, hooks, components, config, and coming-from-wagmi
  • /llms-full.txt carries the full reference text, no HTML
  • Both answer at docs.dappbooster.cc/llms.txt and /llms-full.txt after a deploy
  • The same writer runs under docs:check in a compare mode: it regenerates both files in memory and fails when either is missing or differs from what is committed or built
  • Links in /llms.txt are absolute

Technical notes

docs:build runs typedoc into the typedoc/ folder Vercel serves; write both files in that step so they track the reference. The JSDoc already holds the per-symbol text that /llms-full.txt flattens.

Typedoc emits HTML only and has no built-in llms.txt output. Three routes were checked:

  • typedoc-plugin-llms-txt (v0.1.2, peer typedoc ^0.28) writes the index file only, so it cannot cover /llms-full.txt.
  • typedoc-plugin-markdown (v4.13.0, peer typedoc 0.28.x) emits markdown beside the HTML through the outputs array, but joining it into one file is still ours to write.
  • typedoc --json is already in the core and dumps the whole reflection tree, comments included. One script in kit/ reads that and writes both files, which matches kit/docs-check.mjs and kit/check-anatomy.mjs and adds no plugin to track.

Additional context

M1 deliverable: agentic-ready documentation. /llms.txt follows llmstxt.org. /llms-full.txt is not in that spec: it is the common convention for a whole docs site in one file, and the hyphenated spelling is the one to use. Sits with #207 (docs site) and BootNodeDev/dappbooster-canton-landing#14 (landing).

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestpriority: highMust be addressed in current sprintwontfixThis will not be worked on

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions