Repository navigation
Ship a generated single-file API reference for LLM agents - #143
Merged
Merged
Conversation
Emits a single-page reference from the TypeDoc model, sized for LLM consumption. Organisation is derived rather than configured: types are grouped by the module that declares them, and FeltController's members by the controller they are inherited from, so a new type or method is placed without anyone maintaining a taxonomy. The generator asserts that every FeltController member and every exported type is emitted exactly once, and fails the build otherwise. Property comments that only restate the property name are dropped, and short object shapes are kept on one line; together those account for most of the difference between readable output and something several times larger. Pass --examples to include each method's first @example. Co-authored-by: Cursor <cursoragent@cursor.com>
… build and check Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
noisyneuron
force-pushed
the
sukanya/generate-llm-docs
branch
from
September 17, 2026 14:40
bc14d8f to
392d6ee
Compare
Co-authored-by: Cursor <cursoragent@cursor.com>
noisyneuron
marked this pull request as ready for review
September 17, 2026 19:09
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
2 participants
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.
The SDK now publishes
llms-full.txt, a single-file reference of the public API written for LLM agents rather than people. It's generated from the TypeScript types and TSDoc on every build and checked for drift alongside the existing docs, so it can't fall out of step with the code. The name follows thellms.txtconvention so agents and tooling know what it is, and it ships as a loose file in the npm package, like the README, so consumers can read it straight fromnode_moduleswithout it touching their bundle.Test plan
npm run build. Observe thatllms-full.txtis written to the repo root and the console reports its member and type counts and size.npm pack --dry-run. Observe thatllms-full.txtis listed in the tarball contents.src/and runnpm run checkwithout rebuilding. Observe that the docs check fails and namesllms-full.txtas out of date.