Audit and expand llms.txt API reference#90
Conversation
|
To view this pull requests documentation preview, visit the following URL: Documentation is deployed and generated using docs.page. |
There was a problem hiding this comment.
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.txtAPI 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.mdxredirect and simplified the docs workflow to only assertllms.txtexists.
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.
.github/workflows/docs.yml
Outdated
| - name: Verify llms.txt exists | ||
| run: | | ||
| test -s llms.txt || { | ||
| echo "llms.txt is missing or empty." | ||
| exit 1 | ||
| } |
There was a problem hiding this comment.
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.
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.