Skip to content

docs: add docs repo and update step to PR workflow #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kopahead merged 1 commit into from
Apr 26, 2026
+3 −1
Merged

docs: add docs repo and update step to PR workflow #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ src/
| supaproxy-server (this) | Public (MIT) | Engine: API server |
| supaproxy-sdk | Public (MIT) | TypeScript SDK (`@supaproxy/sdk` on npm) |
| supaproxy-dashboard | Private | Astro + React frontend |
| supaproxy-docs | Private | Mintlify documentation site |

## Start Dev

Expand Down Expand Up @@ -136,7 +137,8 @@ pnpm dev # API on :3001
2. Make changes following the code rules above
3. Run `/audit-code` to catch violations
4. Run tests: `pnpm test`
5. Open PR against `main`
5. If the change affects API endpoints, request/response shapes, or user-facing behaviour: note which pages in [supaproxy-docs](https://github.com/NumstackPtyLtd/supaproxy-docs) need updating
6. Open PR against `main`

### Adding a New Route
Run `/add-api-route` or follow the pattern in `src/routes/`. Every route file:
Expand Down