Skip to content

docs: correct the developer docs where they drift from the code #15

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
TheGreatAxios merged 1 commit into from
Oct 31, 2026
Merged

docs: correct the developer docs where they drift from the code #15

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ covers the architecture, tests and other scripts.
bun run vendor:verify # vendored Interchange matches its manifest
```

`bun run format` fixes formatting. Changes to the hub's API also need
`bun run format` fixes formatting. Changes to model logins also need
`bun run test:e2e` against a real Postgres
([docs/DEV.md](https://github.com/corbitsdev/corbits-builder/blob/main/docs/DEV.md#tests)).

Expand Down
12 changes: 7 additions & 5 deletions docs/DEV.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ running with Docker Compose is in
| `apps/hub` | The server: a Postgres control plane, tenancy and sign-in, documents (versioned artifacts with content hashes), approvals and the glue that starts each role. It runs Interchange in-process. |
| `packages/client` | A typed client for the hub's API (`@corbits-builder/client`). It never touches the database or Interchange internals. |
| `apps/web` | The UI: Vite and React over that client, with its own small router in `src/routes.ts`. |
| `workflows/*` | One package per role: its agent, prompt, tools and workflow definition. |
| `workflows/*` | One package per role: its agent, prompt and workflow definition; the hub supplies its tools. |
| `packages/schemas` | Types and schemas shared by the hub, the client and the workflows. |
| `scripts/` | Dev, loop and verification scripts. |
| `scripts/` | Dev and verification scripts: pin and vendor checks, the commit check, the Google sign-in emulator and React UI API generation. |
| `deploy/` | The Dockerfile and Compose files ([SELF_HOST.md](https://github.com/corbitsdev/corbits-builder/blob/main/docs/SELF_HOST.md)). |

The roles:
Expand Down Expand Up @@ -61,7 +61,7 @@ bun run typecheck
bun run test # unit and integration tests
bun run pins:verify # pinned dependency versions
bun run vendor:verify # vendored Interchange matches its manifest
bun run test:e2e # the API end to end against an isolated Postgres
bun run test:e2e # model logins end to end against an isolated Postgres
```

`bun run test:e2e` reads the `E2E_DB_*` values from `.env.hub`. Start its
Expand Down Expand Up @@ -101,8 +101,10 @@ real API ([CONTRIBUTING.md](https://github.com/corbitsdev/corbits-builder/blob/m
- Providers, models, roles and profiles: `apps/hub/src/config/models.ts`;
each model's limits: `apps/hub/src/inference/model-limits.ts`.
- Database schema and migrations: `apps/hub/src/db/`.
- Hub routes: `apps/hub/src/projects/`, `artifacts/`, `builds/`, `settings/`.
- Hub routes: mounted in `apps/hub/src/app.ts`; each project's routes in
`apps/hub/src/projects/routes.ts`.
- Starting and placing sidecars: `apps/hub/src/provisioning/`,
`apps/hub/src/sidecar/`.
- Each role's prompt and tools: `workflows/<role>/src/`.
- Each role's prompt: `workflows/<role>/src/`. Its `defineTool` tools:
`apps/hub/src/` (`artifacts/`, `projects/`, `builds/`, `skills/`).
- Interchange docs: `vendor/interchange/docs/`.
2 changes: 2 additions & 0 deletions docs/IMPLEMENTATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,8 @@ Environment files, installs and build output never leave the workspace.
| `packages/schemas` | `@corbits-builder/schemas` | Types and schemas shared by the hub, client and workflows. |
| `vendor/interchange` | | Interchange at the pinned revision. |
| `deploy/` | | The Dockerfile and Compose files. |
| `scripts/` | | Dev and verification scripts. |
| `skills/` | | Agent skills to install Builder and drive it through its API. |
| `test/integration`, `e2e` | | Cross-module and full-stack tests. |

Workflow packages declare their agents and workflows with Interchange's
Expand Down