feat: add API documentation generation with TypeDoc #89
Conversation
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
- Add TypeDoc configuration for @solana/client package - Add docs and docs:json scripts for generating API documentation - Add CI workflow to build and publish docs to GitHub Pages - Generate markdown and JSON API specs from TypeScript/JSDoc - Add docs task to turbo.json Closes solana-foundation#85
GuiBibeau
requested changes
Dec 16, 2025
Collaborator
GuiBibeau
left a comment
GuiBibeau
left a comment
There was a problem hiding this comment.
i think deploying to github pages is not needed for now, we need the code to get the typedocs done but we'll have another place to export them soon
- Remove workflow_dispatch trigger - Remove GitHub Pages deployment job - Keep TypeDoc generation with artifact upload - Docs will be deployed to solana.com in future PR
Author
|
Thanks for the feedback! I've updated the workflow:
Ready for re-review! |
Collaborator
|
Incredible! Can you generate a patch changeset for this and we'll ship it? @N-45div |
Author
I have added the same ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Summary
Adds TypeDoc-based API documentation generation for the
@solana/clientpackage, addressing #85.Changes
docsanddocs:jsonfor generating API documentationdocsanddocs:jsontasksGenerated Output
api.json(1.4MB) for tooling integrationHow to Test Locally
pnpm install pnpm --filter @solana/client build pnpm --filter @solana/client docs # Check packages/client/docs/Closes #85