Skip to content

Conversation

@strands-agent
Copy link
Contributor

Description

Fixes the empty TypeScript API section in llms.txt by using a recursive glob pattern to include all TypeScript API documentation files.

Problem

The current llms.txt configuration uses docs/api-reference/typescript/*.html which only matches files in the root directory. However, typedoc generates documentation into subdirectories:

  • classes/ - Agent, Tool, Message classes
  • types/ - TypeScript type definitions
  • interfaces/ - Interface definitions
  • functions/ - Exported functions

This 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 *.html to **/*.html to recursively match all HTML files generated by typedoc.

Before

TypeScript API:
  - docs/api-reference/typescript/*.html  # Only matches 2 files in root

After

TypeScript API:
  - docs/api-reference/typescript/**/*.html  # Matches all 123 HTML files

Related Issues

Fixes #426

Type of Change

Bug fix

Testing

Verified locally:

  1. Generated TypeScript docs with npm run docs:ts
  2. Confirmed 123 HTML files exist across subdirectories
  3. Verified the glob pattern change matches all files

Checklist

  • I have read the CONTRIBUTING document
  • My changes generate no new warnings
  • This is a one-line configuration fix

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] TypeScript API section is empty of llms.txt is missing

1 participant