Add TypeDoc API reference documentation - #21
Open
151henry151 wants to merge 2 commits into
Open
Conversation
Generate browsable API docs from ubrn-produced TypeScript bindings, integrate at /api/ on the Zensical site, and add just api-docs / just docs-build recipes with pnpm-based CI deployment.
Generated bindings do not exist on a fresh checkout, so pnpm install must use --ignore-scripts until after ubrn:android runs.
Author
|
The Docs workflow failed because pnpm install triggered prepare (bob build) before ubrn:android had created src/generated/ — the same chicken-and-egg the repo already avoids locally with --ignore-scripts. Fixed by adding --ignore-scripts to the install step in docs.yml. |
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
1 participant
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.
Issue #6 asked for API documentation tooling and workflow for the React Native bindings. The project had Zensical guide docs but no browsable API reference; integrators were pointed at example apps to discover the API.
This adds TypeDoc generation from the UniFFI-produced TypeScript bindings (with JSDoc propagated from bdk-ffi Rust doc comments), integrates the output at
/api/on the existing GitHub Pages site, and addsjust api-docs/just docs-buildwith a CI workflow to build and deploy on push tomaster.The TypeDoc landing page lives in
typedoc-readme.mdat the repo root (outsidedocs/) so Zensical does not emit an orphan/api-index/page. The docs CI workflow uses pnpm 10.27.0 with a SHA-pinnedpnpm/action-setupaction, matchingpackageManagerinpackage.json. It also runs on pull requests (build only; deploy is gated to push onmaster). Main CI still uses yarn; fixing that is a separate follow-up.Closes #6
Tested with:
just docs-build— passedAll local verification checks (site output, Wallet JSDoc, orphan page absent, typedoc-readme content in API index) — passed