Pond API Docs
Welcome to the documentation for Pond — a small NestJS + MongoDB sandbox for typed User / Role CRUD.
These pages are split into three layers:
| Layer | Source | Regenerated by |
|---|---|---|
| Introduction + runbook | Hand-written | Editors |
| Architecture / endpoints / data models | Auto-generated from @Schema(), @Controller(), @Module() decorators via ts-morph | scripts/gen-docs.sh |
| API reference (every class, type, method) | Auto-generated from TSDoc blocks via TypeDoc | scripts/gen-docs.sh |
Where to start
- Just want to run it? Read
docs/RUNBOOK.mdin the repo. - Want the one-page architecture tour?
docs/ARCHITECTURE.md. - Writing a new endpoint? See the
pond-scaffolderagent — it enforces the Users/Roles shape byte-for-byte. - Looking for a specific endpoint's behavior? See Endpoint Overview.
Ports (do not change without agreement)
| Port | Service |
|---|---|
| 4100 | Pond API |
| 27018 | pond-mongo (docker) |
| 8083 | mongo-express |
Regenerating docs
From the project root:
./scripts/gen-docs.sh
This runs TypeDoc + the ts-morph introspection pass and overwrites everything under docs-site/docs/api-reference/ and docs-site/docs/generated/.
Open http://localhost:4141 after cd docs-site && pnpm install && pnpm start to preview.