fix(llmstxt): include TypeScript API docs in llms.txt#449
Open
strands-agent wants to merge 1 commit intostrands-agents:mainfrom
Open
fix(llmstxt): include TypeScript API docs in llms.txt#449strands-agent wants to merge 1 commit intostrands-agents:mainfrom
strands-agent wants to merge 1 commit intostrands-agents:mainfrom
Conversation
The TypeScript API documentation is generated by typedoc into subdirectories (classes/, types/, interfaces/, functions/), but the llmstxt plugin configuration only matched *.html in the root directory. This change uses **/*.html to recursively include all TypeScript API documentation files in llms.txt, enabling AI coding assistants to help users write TypeScript code. Fixes strands-agents#426
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
1 participant
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.
Description
Fixes the empty TypeScript API section in
llms.txtby using a recursive glob pattern to include all TypeScript API documentation files.Problem
The current llms.txt configuration uses
docs/api-reference/typescript/*.htmlwhich only matches files in the root directory. However, typedoc generates documentation into subdirectories:classes/- Agent, Tool, Message classestypes/- TypeScript type definitionsinterfaces/- Interface definitionsfunctions/- Exported functionsThis results in an empty TypeScript API section in llms.txt, blocking AI coding assistants (Claude Code, Cursor, Windsurf) from helping users write TypeScript code.
Solution
Change the glob pattern from
*.htmlto**/*.htmlto recursively match all HTML files generated by typedoc.Before
After
Related Issues
Fixes #426
Type of Change
Bug fix
Testing
Verified locally:
npm run docs:tsChecklist