chore: Trigger API docs deployment on release tags#2040
Merged
ananas-block merged 8 commits intomainfrom Nov 8, 2025
Merged
Conversation
added 7 commits
November 6, 2025 15:37
Set up TypeDoc to generate API reference documentation for @lightprotocol/stateless.js and @lightprotocol/compressed-token packages. Configuration uses packages mode for monorepo support with customized options for navigation, sorting, and external links. Changes: - Add typedoc.json with monorepo-aware configuration - Add TypeDoc as devDependency in root package.json - Update .gitignore to exclude generated api-docs directory - Update pnpm-lock.yaml with TypeDoc dependencies
Automates deployment of API documentation to GitHub Pages. Workflow triggers on pushes to main branch and: - Installs dependencies with pnpm - Builds stateless.js package - Generates TypeDoc documentation - Deploys to GitHub Pages Docs will be available at: https://lightprotocol.github.io/light-protocol/
Split documentation generation into separate sites for each package: - stateless.js: /stateless.js/ - compressed-token: /compressed-token/ Changes: - Add typedoc.stateless.json for stateless.js package - Add typedoc.compressed-token.json for compressed-token package - Add api-docs-index.html as landing page linking to both - Update workflow to generate both packages separately - Remove unified typedoc.json URLs after deployment: - Root: https://lightprotocol.github.io/light-protocol/ - Stateless.js: https://lightprotocol.github.io/light-protocol/stateless.js/ - Compressed-token: https://lightprotocol.github.io/light-protocol/compressed-token/
- Rename 'API Home' to 'Other Libraries' in navigation header - Update docs.zkcompression.com to www.zkcompression.com - Fix compressed token guide link to point to /compressed-tokens/guides - Add 'Other Libraries' link to both package READMEs
Add Ask DeepWiki badge next to npm and license badges for quick access to AI-powered documentation assistant.
Quote GITHUB_ENV variable to prevent globbing
Changes workflow to deploy TypeDoc to GitHub Pages only when release tags are pushed (compressed-token-* or stateless.js-*), ensuring API documentation reflects latest release versions rather than main branch. Addresses: #2038
Contributor
|
Important Review skippedAuto reviews are limited based on label configuration. 🏷️ Required labels (at least one) (1)
Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
|
needs rebase @tilo-14 |
ananas-block
changed the title
ananas-block
approved these changes
Nov 8, 2025
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.
Summary
Changes the TypeDoc GitHub Pages deployment workflow to trigger on release tags instead of every push to main.
Changes
compressed-token-*orstateless.js-*are pushedExamples
stateless.js-v0.22.1-alpha.1compressed-token-v0.22.1-alpha.2Related