Skip to content

Audit and expand llms.txt API reference#90

Merged
leoafarias merged 6 commits intomainfrom
leoafarias/find-undoc-members
Mar 5, 2026
Merged

Audit and expand llms.txt API reference#90
leoafarias merged 6 commits intomainfrom
leoafarias/find-undoc-members

Conversation

@leoafarias
Copy link
Collaborator

This PR audits and updates llms.txt to match the current ack and ack_annotations API surface on 1.0.0-beta.9. It adds missing reference coverage for object composition helpers, string/number/list fluent constraints, typed parseAs/safeParseAs mapper usage, SchemaResult.map, annotation options, and canonical JsonSchema model fields. It also fixes stale version/deprecation notes and clarifies current @AckType discriminated and nullable behavior. The docs/llms.txt.mdx redirect page is removed so llms.txt remains the single canonical source.

@docs-page
Copy link

docs-page bot commented Mar 4, 2026

To view this pull requests documentation preview, visit the following URL:

docs.page/btwld/ack~90

Documentation is deployed and generated using docs.page.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the repository’s llms.txt reference document to reflect the current Ack / ack_annotations API surface for 1.0.0-beta.9, and removes the docs-site redirect page so the root llms.txt is the intended single canonical source.

Changes:

  • Expanded llms.txt API reference coverage (object composition helpers, fluent constraints, parseAs/safeParseAs, SchemaResult.map, annotation options, JsonSchema model surface).
  • Updated version and “supported vs next beta” notes to 1.0.0-beta.9, and adjusted guidance around @AckType / nullable behavior.
  • Removed docs/llms.txt.mdx redirect and simplified the docs workflow to only assert llms.txt exists.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
llms.txt Adds/updates API reference coverage and examples for beta.9.
docs/llms.txt.mdx Removes the docs-site redirect page for /llms.txt.
.github/workflows/docs.yml Drops redirect verification; now only checks root llms.txt exists before running docs.page validation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 31 to 36
- name: Verify llms.txt exists
run: |
test -s llms.txt || {
echo "llms.txt is missing or empty."
exit 1
}
Copy link

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With docs/llms.txt.mdx removed, the docs site no longer appears to have a /llms.txt route, but docs/index.mdx still links to /llms.txt as a redirect target. Consider restoring a docs route (redirect page or static file) or updating the docs link to point directly at the canonical raw llms.txt URL, and add a CI check that this route/link stays valid.

Copilot uses AI. Check for mistakes.
@leoafarias leoafarias merged commit dfbf916 into main Mar 5, 2026
3 checks passed
@leoafarias leoafarias deleted the leoafarias/find-undoc-members branch March 5, 2026 15:30
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.

2 participants