Skip to content

TRA-862: publish agent-friendly documentation surfaces - #222

Open
edmacabebe wants to merge 5 commits into
mainfrom
feat/TRA-862-agent-friendly-docs
Open

edmacabebe wants to merge 5 commits into
mainfrom
feat/TRA-862-agent-friendly-docs

Conversation

@edmacabebe

@edmacabebe edmacabebe commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Linear issue: TRA-862

Scope: Adds docusaurus-plugin-llms 0.6.0, per-page Markdown mirrors, llms.txt, llms-full.txt, API-scoped llms-api.txt, homepage discovery, static MDX OpenAPI fallback, and output checks.

Validation: pnpm install --frozen-lockfile; pnpm typecheck; pnpm lint; pnpm build; pnpm check:agent-docs — passed.

Generated output: 42 documents; llms-api.txt contains 17 API docs and the check rejects user-guide/app-tour links.

Preview: local build verified; process-isolated curl could not reach the local server. Preview deployment verification remains for review.

No TRA-308 MCP/runtime-agent work included.

@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment Update

✅ This PR has been successfully merged into the preview branch.

The preview environment will update shortly at: https://docs.preview.trakrf.id

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 23, 2026 •

Copy link
Copy Markdown

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9dfcadc
Status: ✅  Deploy successful!
Preview URL: https://a1996fe4.docs-4n7.pages.dev
Branch Preview URL: https://feat-tra-862-agent-friendly.docs-4n7.pages.dev

View logs

@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment Update

✅ This PR has been successfully merged into the preview branch.

The preview environment will update shortly at: https://docs.preview.trakrf.id

@mikestankavich mikestankavich left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good, merge it

Mike Stankavich and others added 3 commits November 4, 2026 06:46
…page

An agent only found llms-full.txt if it already knew the convention:
llms.txt and the home page linked llms.txt alone. llms.txt now opens
with links to both single-file variants and steers agents to per-page
.md as the reliable route.

Refs: TRA-862

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…est entries

The 150 KB changelog is mostly pre-launch history. The single-file
agent docs keep its intro and newest 8 entries and link to the full
changelog .md, which stays complete. check-agent-docs now runs in the
build and asserts the links, the trim, and the untouched mirror.

Refs: TRA-862

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown

🚀 Preview Deployment Update

✅ This PR has been successfully merged into the preview branch.

The preview environment will update shortly at: https://docs.preview.trakrf.id

@mikestankavich

Copy link
Copy Markdown
Contributor

Pushed three commits onto this branch, no force-push:

  • be88330: merged main in, so this branch now runs under the lint + typecheck CI gate.
  • 6f919cc: llms.txt now opens with links to llms-full.txt and llms-api.txt (via the plugin's rootContent), and the home page links llms-full.txt next to llms.txt. Before this, an agent found the single-file variants only by guessing the URL.
  • 9dfcadc: scripts/trim-llms-changelog.mjs runs after docusaurus build and trims the API changelog in llms-full.txt and llms-api.txt to its intro and newest 8 entries, then links to the full changelog .md. The per-page mirror stays complete. llms-full.txt goes from 547 KB to 406 KB. check-agent-docs.mjs now runs as part of build and asserts the links, the trim, and the complete mirror.

🤖 Generated with Claude Code

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