Skip to content

docs: align usage contracts and discovery surfaces - #1421

Open
EmersonBraun wants to merge 22 commits into
mainfrom
agent/docs-usage-coherence
Open

docs: align usage contracts and discovery surfaces#1421
EmersonBraun wants to merge 22 commits into
mainfrom
agent/docs-usage-coherence

Conversation

@EmersonBraun

Copy link
Copy Markdown
Member

Summary

  • Align the canonical documentation with the public usage contracts, including createHybridRetriever, RAG/retriever guidance, and actionable error links.
  • Refresh package and site READMEs, cross-references, and the /integrations, /recipes, /publications, and /ecosystem discovery surfaces.
  • Keep canonical metadata, JSON-LD, sitemap/robots, llms.txt, and deterministic knowledge artifacts coherent for search engines and LLM retrieval.

Validation

  • node scripts/check-quality-gates.mjs — 33/33 passed
  • pnpm exec vitest run --config apps/docs-next/vitest.config.ts — 8 files, 37 tests passed
  • pnpm --filter @agentskit/docs-next exec tsc --noEmit — passed
  • pnpm --filter @agentskit/docs-next check:links — 2,250 links across 422 files
  • pnpm --filter @agentskit/docs-next exec next build --webpack — 1,199/1,199 pages
  • Full pre-push lint/build — 56 lint tasks and 42 build tasks passed
  • Ecosystem documentation attestation — certified and verified locally

Production deployment is intentionally performed after PR checks and will be validated against the canonical production routes. No external indexing request is included.

Comment thread apps/docs-next/tests/documentation-contracts.test.ts Fixed
Comment thread apps/docs-next/tests/documentation-contracts.test.ts Fixed
@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse

URL Performance Accessibility Best practices SEO
http://127.0.0.1:3000/ 77 92 96 100
http://127.0.0.1:3000/docs 73 100 96 100
http://127.0.0.1:3000/docs/get-started/getting-started/quickstart 73 96 96 100
http://127.0.0.1:3000/stack 90 100 96 100
http://127.0.0.1:3000/showcase 94 100 96 100

Run by .github/workflows/lighthouse.yml.

@EmersonBraun
EmersonBraun marked this pull request as ready for review August 13, 2026 00:04
@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse

URL Performance Accessibility Best practices SEO
http://127.0.0.1:3000/ 41 92 96 100
http://127.0.0.1:3000/docs 68 100 96 100
http://127.0.0.1:3000/docs/get-started/getting-started/quickstart 69 96 96 100
http://127.0.0.1:3000/stack 87 100 96 100
http://127.0.0.1:3000/showcase 92 100 96 100

Run by .github/workflows/lighthouse.yml.

Comment thread apps/docs-next/tests/documentation-contracts.test.ts Fixed
Comment thread apps/docs-next/tests/documentation-contracts.test.ts Fixed
Comment thread apps/docs-next/tests/documentation-contracts.test.ts Fixed
Comment thread apps/docs-next/tests/documentation-contracts.test.ts Fixed
Comment thread apps/docs-next/tests/documentation-contracts.test.ts Fixed
Comment thread apps/docs-next/tests/documentation-contracts.test.ts Fixed
Comment thread apps/docs-next/tests/documentation-contracts.test.ts Fixed
@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse

URL Performance Accessibility Best practices SEO
http://127.0.0.1:3000/ 77 92 96 100
http://127.0.0.1:3000/docs 71 100 96 100
http://127.0.0.1:3000/docs/get-started/getting-started/quickstart 76 96 96 100
http://127.0.0.1:3000/stack 93 100 96 100
http://127.0.0.1:3000/showcase 93 100 96 100

Run by .github/workflows/lighthouse.yml.

@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse

URL Performance Accessibility Best practices SEO
http://127.0.0.1:3000/ 42 92 96 100
http://127.0.0.1:3000/docs 65 100 96 100
http://127.0.0.1:3000/docs/get-started/getting-started/quickstart 67 96 96 100
http://127.0.0.1:3000/stack 89 100 96 100
http://127.0.0.1:3000/showcase 88 100 96 100

Run by .github/workflows/lighthouse.yml.

@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse

URL Performance Accessibility Best practices SEO
http://127.0.0.1:3000/ 76 92 96 100
http://127.0.0.1:3000/docs 70 100 96 100
http://127.0.0.1:3000/docs/get-started/getting-started/quickstart 69 96 96 100
http://127.0.0.1:3000/stack 90 100 96 100
http://127.0.0.1:3000/showcase 92 100 96 100

Run by .github/workflows/lighthouse.yml.

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