docs(ci): generate and publish typedoc API docs in CI (#613) - #693
Open
ZacLou wants to merge 5 commits into
Open
docs(ci): generate and publish typedoc API docs in CI (#613)#693ZacLou wants to merge 5 commits into
ZacLou wants to merge 5 commits into
Conversation
…uit-protocol#606) - Export resolveFee from src/index.ts so consumers can compute effective fees - Add fee and feeMultiplier rows to ConduitClient configuration table - Add Fee Precedence section to README explaining the resolution order: explicit fee > feeMultiplier * BASE_FEE > BASE_FEE Closes conduit-protocol#606
…l#627) - Add .size-limit.json with 80KB gzip limit for index entry and 30KB for utils - Add size-limit.yml GitHub Actions workflow (runs after build) - Add @size-limit/preset-small-lib devDependency and size-limit npm script
…ol#613) - Add typedoc.json configuration (entryPoints, output dir, sorting) - Add docs.yml GitHub Actions workflow: builds typedoc on PR/push, deploys to GitHub Pages on main merge - Add typedoc devDependency and docs npm script - Exclude tests, private/protected members, and external deps from docs
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.
Closes #613.
Summary
Automatically generates TypeDoc API documentation on every PR/push and publishes it to GitHub Pages on merges to main.
Changes
typedoc.json: configures entry point (src/index.ts), output dir (docs/api), and sorting.github/workflows/docs.yml: builds docs on every PR/push; deploys to GitHub Pages on mainpackage.json: addstypedocdevDependency anddocsnpm scriptNotes