Skip to content

Improve TypeScript SDK API reference navigation - #71833

Merged
jason810496 merged 1 commit into
apache:mainfrom
jason810496:docs/ts-sdk/categorize-api-reference
Aug 20, 2026
Merged

Improve TypeScript SDK API reference navigation#71833
jason810496 merged 1 commit into
apache:mainfrom
jason810496:docs/ts-sdk/categorize-api-reference

Conversation

@jason810496

@jason810496 jason810496 commented Aug 19, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Why

The TypeScript SDK API reference currently mixes user-facing Dag authoring symbols with supporting and runtime details. The language SDK guide also needs to reflect the beta's Dag-based syntax.

What

  • Group the generated API reference into Authoring, Types, Exceptions, and Internals sections using docs-only TypeDoc entry points.
  • Keep coordinator startup APIs out of the public reference and place only SUPERVISOR_API_VERSION under Internals.
  • Preserve exception links across the new documentation sections.
  • Align the TypeScript language SDK guide with Dag, DagRegistry, and serveDags.
  • Trigger the TypeDoc CI build when a documentation category entry point changes.

Verification

Screenshot 2026-08-19 at 6 46 32 PM
Was generative AI tooling used to co-author this PR?

@jason810496 jason810496 self-assigned this Aug 19, 2026
@jason810496 jason810496 removed the backport-to-v3-3-test Backport to v3-3-test label Aug 19, 2026
@jason810496
jason810496 requested a review from uranusjr August 19, 2026 10:56
@jason810496
jason810496 force-pushed the docs/ts-sdk/categorize-api-reference branch from ccc4c33 to 026e96b Compare August 20, 2026 07:11
@jason810496
jason810496 merged commit 6f36bac into apache:main Aug 20, 2026
154 of 155 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@uranusjr uranusjr uranusjr approved these changes
@potiuk potiuk Awaiting requested review from potiuk potiuk is a code owner
@ashb ashb Awaiting requested review from ashb ashb is a code owner
@gopidesupavan gopidesupavan Awaiting requested review from gopidesupavan gopidesupavan is a code owner
@amoghrajesh amoghrajesh Awaiting requested review from amoghrajesh amoghrajesh is a code owner
@jscheffl jscheffl Awaiting requested review from jscheffl jscheffl is a code owner
@bugraoz93 bugraoz93 Awaiting requested review from bugraoz93 bugraoz93 is a code owner
@jedcunningham jedcunningham Awaiting requested review from jedcunningham jedcunningham is a code owner
@ephraimbuddy ephraimbuddy Awaiting requested review from ephraimbuddy ephraimbuddy is a code owner
@choo121600 choo121600 Awaiting requested review from choo121600 choo121600 is a code owner
@vatsrahul1001 vatsrahul1001 Awaiting requested review from vatsrahul1001 vatsrahul1001 is a code owner

Assignees

@jason810496 jason810496

Labels

area:dev-tools area:ts-sdk kind:documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jason810496 @uranusjr