Closed
Conversation
diberry
force-pushed
the
squad/pao-jsdoc-ref-research
branch
2 times, most recently
from
4077aca to
e2f0021
Compare
diberry
pushed a commit
that referenced
this pull request
Mar 24, 2026
- Add TypeDoc + typedoc-plugin-markdown to squad-sdk devDependencies - Create typedoc.json config targeting src/index.ts barrel export - Add scripts/generate-api-docs.mjs for generation + Astro filename normalization - Generate 395 API reference pages (classes, interfaces, functions, types, variables) - Add curated landing page at docs/reference/api/ with categorized index - Add npm script 'docs:api' and integrate into 'docs:build' pipeline - Update navigation sidebar to link to new generated API reference - Cross-link existing hand-written api-reference.md to generated docs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
force-pushed
the
squad/pao-jsdoc-ref-research
branch
from
ac56785 to
5616a4d
Compare
3 tasks
diberry
force-pushed
the
squad/pao-jsdoc-ref-research
branch
2 times, most recently
from
102b6c5 to
480c268
Compare
Owner
Author
|
diberry
force-pushed
the
squad/pao-jsdoc-ref-research
branch
from
480c268 to
bef52f9
Compare
diberry
pushed a commit
that referenced
this pull request
Mar 25, 2026
- nav-before.png: sidebar navigation on dev branch - nav-after.png: sidebar navigation on PR branch with updated labels Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
pushed a commit
that referenced
this pull request
Mar 25, 2026
- nav-before.png: sidebar navigation on dev branch - nav-after.png: sidebar navigation on PR branch with updated labels Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
force-pushed
the
squad/pao-jsdoc-ref-research
branch
from
bef52f9 to
332e114
Compare
diberry
pushed a commit
that referenced
this pull request
Mar 25, 2026
- nav-before.png: sidebar navigation on dev branch - nav-after.png: sidebar navigation on PR branch with updated labels Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
force-pushed
the
squad/pao-jsdoc-ref-research
branch
from
332e114 to
c95fc87
Compare
diberry
pushed a commit
that referenced
this pull request
Mar 25, 2026
- Orchestration logs: Flight APPROVE, PAO REQUEST CHANGES, FIDO COMMENT - Session log: PR #11 review summary - Merged decision inbox: Crosslink pattern, quality recommendations - Deleted inbox files Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
pushed a commit
that referenced
this pull request
Mar 25, 2026
- Orchestration logs: Flight APPROVE, PAO REQUEST CHANGES, FIDO COMMENT - Session log: PR #11 review summary - Merged decision inbox: Crosslink pattern, quality recommendations - Deleted inbox files Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
force-pushed
the
squad/pao-jsdoc-ref-research
branch
from
70aa09d to
c36bd7d
Compare
- TypeDoc config (packages/squad-sdk/typedoc.json) targeting src/index.ts - Generation script (scripts/generate-api-docs.mjs) — produces API pages - Build integration: npm run docs:api generates markdown - Playwright tests (docs/tests/api-reference.spec.mjs) — 8 tests covering landing, classes, functions, interfaces, nav, search - Nav crosslinks: sidebar labels (SDK Guide + API Reference) - Research docs: PRD and research analysis - API reference screenshots (6 detail pages) - PR screenshots capture skill + script Review fixes applied: - Crosslink banner added to sdk.md (PAO) - Nav URL simplified to reference/api (PAO) - CI/CD build order clarified in nav plan (PAO) - Hardcoded export count replaced with > 100 assertion (Flight) - Local typedoc binary instead of npx (Flight) - TypeDoc pinned to ~0.28.18 (Flight) - Error handling added to generation + screenshot scripts (FIDO) Generated docs are NOT committed — they are built at CI/deploy time. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
force-pushed
the
squad/pao-jsdoc-ref-research
branch
from
c36bd7d to
8e5a362
Compare
Owner
Author
|
Reopening as cross-fork PR targeting bradygaster/squad:dev |
This was referenced Mar 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TypeDoc API Reference — Build Pipeline + Tests + Navigation
What this PR delivers
packages/squad-sdk/typedoc.json) targetingsrc/index.tsscripts/generate-api-docs.mjs) — produces 395 API pagesnpm run docs:apigenerates markdown, hooked intodocs:builddocs/tests/api-reference.spec.mjs) — 8 tests covering landing, classes, functions, interfaces, nav, searchdocs/research/jsdoc-api-reference-*.mdGenerated docs are NOT committed
The 395 API markdown files are generated at build time and gitignored. Run
npm run docs:apito generate locally.Navigation — Before & After
Before (dev branch)
After (this PR)
Change: "SDK API Reference" nav entry now points to the auto-generated TypeDoc content (
reference/api/index) instead of the hand-authored page. Nav titles unchanged.Screenshots
API Reference Landing Page
Class Detail Page — RuntimeEventBus
Interface Detail Page — AgentCapability
Function Detail Page — defineSquad
Type Alias Detail Page — AgentRef
Variable Detail Page — DEFAULT_FALLBACK_CHAINS
To verify locally
To run Playwright tests