docs: add Docusaurus documentation website with GitHub Pages deployment#93
Open
docs: add Docusaurus documentation website with GitHub Pages deployment#93
Conversation
…ployment Added a new documentation website using Docusaurus with API reference generation from TSDoc comments. Includes automated deployment workflow to GitHub Pages. - Add Docusaurus website in apps/website/ with TypeDoc plugin - Add GitHub Actions workflow for automated deployment - Update pnpm-lock.yaml with website dependencies - Update ESLint config to ignore Docusaurus config files
Updated all references from zkpservices to p0tion-tools organization and configured proper GitHub Pages deployment URLs. - Update organization name to p0tion-tools - Update base URL for GitHub Pages deployment - Update documentation and repository links - Update copyright attribution
0xarcano
force-pushed
the
docs/api-reference-website-generation
branch
from
ffc7df2 to
5ace0c4
Compare
- Fix lerna ignore pattern to use full package name (@brebaje/website) - Add ESLint ignores for Docusaurus generated files (.docusaurus/**, docs/api/**)
- Update deploy-docs.yml workflow with proper caching and deployment steps - Fix Docusaurus deprecation warning (move onBrokenMarkdownLinks to markdown.hooks) - Consolidate documentation generation to apps/website - Remove root typedoc.json (now managed in docusaurus.config.js) - Update build process to generate comprehensive API documentation - Test workflow locally - all checks passing
- Add build step to deploy-docs.yml workflow to build @brebaje/actions package - Ensures TypeDoc can resolve workspace dependencies via path mappings - Matches pattern used in other workflows (backend, frontend, cli) - Fixes TypeScript module resolution errors in GitHub Actions
AgustinBadi
requested changes
Jan 30, 2026
Contributor
AgustinBadi
left a comment
AgustinBadi
left a comment
There was a problem hiding this comment.
Nice job @0xarcano, I have build the tsdocs and it looks great! I did an extensive review of the code, targeting specially the critical issues.
Co-authored-by: Cursor <cursoragent@cursor.com>
Collaborator
NicoSerranoP
left a comment
NicoSerranoP
left a comment
There was a problem hiding this comment.
haven't finish reviewing the files
Co-authored-by: Cursor <cursoragent@cursor.com>
- Replace npm/npx with pnpm in generate-api-docs and docs scripts - Use logo.svg for social card image in Docusaurus config Co-authored-by: Cursor <cursoragent@cursor.com>
- Add database/** to typedoc exclude in Docusaurus config - Set cleanOutputDir true (plugin is sole generator) - Remove prebuild/generate-api-docs; use docs/docs:watch for Docusaurus Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Nico Serrano <nnicosp@hotmail.com>
NicoSerranoP
approved these changes
Feb 2, 2026
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
apps/website/with TypeDoc plugin for API reference generationChanges
New Website Application (
apps/website/):GitHub Actions Workflow (
.github/workflows/deploy-docs.yml):gh-pagesbranchTest Plan
http://localhost:3000/