Skip to content

feat(docs): generate agent documentation from canonical sources - #154

Merged
joeblau merged 2 commits into
mainfrom
codex/sweep-agent-readiness
Oct 1, 2026
Merged

joeblau merged 2 commits into
mainfrom
codex/sweep-agent-readiness

Conversation

@joeblau

@joeblau joeblau commented Oct 1, 2026 •

Copy link
Copy Markdown

The remaining local feat/agent-readiness branch predates the Bun workspace move and overlaps the existing agent docs. Integrate its additional generators and tests into apps/docs, preserving the current site layout, trust pages, sitemap, and Markdown mirrors.

  • Generate llms.txt and llms-full.txt from the canonical documentation, with absolute Markdown links and the SDK package version.
  • Share and safely serialize homepage JSON-LD, add the agent-index alternate link, and mark the 404 page as noindex.
  • Run the helper tests in docs CI, verify every generated page, and rebuild docs when the SDK manifest changes.

Validation: bun run check, 10 docs helper tests, NEXT_PUBLIC_BASE_PATH=/hyperliquid bun run docs:check, and the production docs build passed. Static export verification covered 13 docs pages, 1,151 internal links/assets, 341 anchors, 14 social cards, and 22 agent artifacts.

All GitHub PR checks passed: Code Quality, Documentation, offline tests, Performance, and Security. The local full offline run hit two five-second timeouts during concurrent builds; both affected tests passed in isolation with the same Bun 1.4 canary runtime.

Integrated local branch tip: ea8f56ecbea82892a0d0796e78d62cc5c739e9ac.

joeblau and others added 2 commits September 26, 2026 14:25
- llms.txt with when-to-use guidance, call examples, and every docs page (generated from the docs source)
- llms-full.txt with every page's Markdown, links made absolute
- sitemap.xml with lastmod for every page
- SoftwareApplication + Organization (with contactPoint) + WebSite JSON-LD on the homepage
- llms.txt alternate link on every page; footer links to About, Contact, Privacy, llms.txt
- branded 404 page linking the docs, sitemap, and llms.txt
- unit tests for the generators; verify-export now gates on the agent files; CI runs the tests

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@joeblau
joeblau merged commit 134ca69 into main Oct 1, 2026
6 checks passed
@joeblau
joeblau deleted the codex/sweep-agent-readiness branch October 1, 2026 17:28
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