Skip to content

docs: API reference navigation and crosslinks#15

Closed
diberry wants to merge 1 commit intodevfrom
squad/pao-api-ref-nav
Closed

docs: API reference navigation and crosslinks#15
diberry wants to merge 1 commit intodevfrom
squad/pao-api-ref-nav

Conversation

@diberry
Copy link
Copy Markdown
Owner

@diberry diberry commented Mar 24, 2026

Summary

Follow-up to #11 (TypeDoc build pipeline). Adds navigation and content crosslinks for the auto-generated API reference.

Changes

  • Sidebar navigation: Rename 'SDK' → 'SDK Guide', update 'API Reference (TypeDoc)' to point to generated api/index
  • api-reference.md: Add superseded notice directing users to the TypeDoc API reference
  • sdk.md: Add crosslink to the auto-generated API reference

Dependencies

This PR depends on #11 being merged first (the generated api/ directory must exist at build time for navigation links to resolve).

Checklist

  • Navigation links point to correct generated paths
  • Crosslinks use relative paths where possible
  • No generated files committed

- Update sidebar: rename 'SDK' to 'SDK Guide', point 'API Reference (TypeDoc)' to generated api/index
- Add superseded notice to api-reference.md pointing to TypeDoc API reference
- Add crosslink in sdk.md to the auto-generated API reference

Follow-up to the TypeDoc build pipeline PR (squad/pao-jsdoc-ref-research).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry
Copy link
Copy Markdown
Owner Author

diberry commented Mar 24, 2026

Nav changes cherry-picked into PR #11 (commit ade546c). This PR is no longer needed.

@diberry diberry closed this Mar 24, 2026
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