docs(api): add typedoc reference generation - #22
Open
Hqzdev wants to merge 6 commits into
Open
Conversation
CI failed before reaching contract tests because API typecheck used the root wrapper and bot tracing used an outdated OpenTelemetry SDK. Running API typecheck from the package and updating tracing keeps the checks aligned with their installed dependencies. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
API typecheck needs the package-level install before TypeScript can resolve queue and realtime dependencies. Updating Next also clears the web audit failure reported by dependency scanning. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Hqzdev
added
api
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
3 participants
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.
What changed
npm run docs:typedocandtypedoc.jsonfor API/reference generation.Notes
The generated
docs/api-referenceoutput is intentionally not committed in this PR;npm run docs:typedocgenerates it from source when needed.This branch is based on the green CI-fix branch so checks can run cleanly. After that branch lands, this PR diff should collapse to TypeDoc/JSDoc changes only.
Validation
npm run docs:typedocnpm audit --audit-level=highnpm run typecheck:apinpm run typecheck:web