feat(docs): TypeDoc API docs + GitHub Pages deploy on release tags (#122) - #172
Open
shinzoxD wants to merge 1 commit into
Open
feat(docs): TypeDoc API docs + GitHub Pages deploy on release tags (#122)#172shinzoxD wants to merge 1 commit into
shinzoxD wants to merge 1 commit into
Conversation
Implements Adamantine-guild#122: - Harden typedoc.json (exclude externals, viem link maps, clean validation) - GitHub Actions docs.yml builds TypeDoc and deploys Pages on v* tags - npm run docs / docs:check scripts - Deduplicate ProviderOptions (fixes TypeDoc multi-declaration warnings) - README section for local docs generation Payout wallet: GBVHELLD2JE235Y2NGTDT3MWI3T65ON6SY4N6FBHYVDAQ5FZC2CP5QXH
2 tasks
Contributor
Author
|
Ready for auto-merge — checks green, mergeable CLEAN. Payout wallet: |
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.
Summary
Implements #122 Build Automated TypeDoc API Documentation Generator and CI Publisher.
SDK docs were manual Markdown that drifted from the code. This PR wires TypeDoc to extract API docs from TypeScript and auto-deploys HTML to GitHub Pages on release tags.
Changes
typedoc.json— exclude private/externals, viem external link maps, relaxed invalid-link noise from dependency types.github/workflows/docs.yml— onv*tags (and manual dispatch):npm ci→npm run docs→ upload →deploy-pagespackage.json—docs/docs:checkscriptssrc/network/provider.ts— remove duplicatedProviderOptionsinterfaces (TypeDoc multi-declaration warnings).gitignore— ignore generateddocs/Acceptance
@paramtags elsewhere)v*)Test plan
npm run docs # → docs/index.html generatedPayout wallet (Stellar)
GBVHELLD2JE235Y2NGTDT3MWI3T65ON6SY4N6FBHYVDAQ5FZC2CP5QXHCloses #122