Skip to content

Comments

API specs in llms.txt#3709

Merged
ethanpalm merged 3 commits intomainfrom
api-specs-llmstxt
Feb 24, 2026
Merged

API specs in llms.txt#3709
ethanpalm merged 3 commits intomainfrom
api-specs-llmstxt

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Feb 24, 2026

Documentation changes

This PR updates the llms.txt page with the info that API specs are included in the files.


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Docs-only wording and example updates; no runtime or API behavior changes.

Overview
Updates the llms.txt documentation to clarify that generated outputs can include API specification links (OpenAPI/AsyncAPI) and that API reference page descriptions incorporate openapi/api frontmatter data, with an expanded example showing an API specifications section.

Also tweaks wording around llms-full.txt indexing and how deleting custom llms.txt/llms-full.txt restores the autogenerated files, and adds llms to the Vale accepted vocabulary to avoid lint errors.

Written by Cursor Bugbot for commit 1b74504. This will update automatically on new commits. Configure here.

@ethanpalm ethanpalm merged commit 9fbf51b into main Feb 24, 2026
5 checks passed
@ethanpalm ethanpalm deleted the api-specs-llmstxt branch February 24, 2026 19:22
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.

1 participant