docs: add CloudMind OS Code Wiki for monorepo structure#3
docs: add CloudMind OS Code Wiki for monorepo structure#3chedevlooper-creator wants to merge 3 commits into
Conversation
Co-authored-by: traeagent <traeagent@users.noreply.github.com>
🐙 Octopus Review — PR #3SummaryThis PR adds a new Score
Risk Assessment
Positive Highlights
Important Files Changed
Last reviewed commit: 946ba9f Checklist
|
There was a problem hiding this comment.
1 file reviewed, 7 findings | View scores & details
🟡🔵💡 Additional findings
| Severity | File | Title | Description |
|---|---|---|---|
| 🟡 | docs/CODE_WIKI.md:L218 |
Browser Service listed as :3007 but no port is officially registered | The Browser Service is documented as running on port :3007, but the architecture docs, README, and root package.json dev… |
| 🟡 | docs/CODE_WIKI.md:L24 |
file:/// link scheme is unusable outside a local checkout | Every hyperlink in this document uses the file:///workspace/... scheme (e.g., file:///workspace/docs/AGENT.md). Thes… |
| 🔵 | docs/CODE_WIKI.md:L388 |
pnpm typecheck described as working but AGENTS.md documents it as a no-op | AGENTS.md explicitly notes that pnpm typecheck is currently a no-op because no package defines a typecheck script,… |
| 🔵 | docs/CODE_WIKI.md:L377 |
Missing vitest version split caveat relevant to test contributors | AGENTS.md documents an important gotcha: services/auth and services/workspace pin vitest@^4.1.5 while other servic… |
| 💡 | docs/CODE_WIKI.md:L78 |
Line-number anchors in file:/// links will rot quickly | Many links include explicit line-number fragments like #L91-L108 or #L45-L81. Even if converted to relative links, t… |
| 💡 | docs/CODE_WIKI.md:L54 |
README.md architecture diagram reference may be stale | The wiki defers to README.md#L116-L160 for the "accurate, current" architecture diagram. AGENTS.md and ARCHITECTURE.md… |
| 💡 | docs/CODE_WIKI.md:L86 |
packages/shared described as having shared infrastructure helpers, but it is documented as source-only Zod DTOs | STRUCTURE.md and CONVENTIONS.md describe @pcp/shared as a pure-TS package of Zod DTOs with no build step. The wiki als… |
Reviewed by Octopus Review, an AI-powered PR review tool.
There was a problem hiding this comment.
Pull request overview
Adds a new in-repo “Code Wiki” document intended to centralize architectural/contextual knowledge for the CloudMind OS monorepo and provide deep links into key packages/services for onboarding and navigation.
Changes:
- Introduces
docs/CODE_WIKI.mddescribing monorepo layout, service boundaries, and dependency relationships. - Documents responsibilities and key entry points for shared packages and each backend service.
- Adds local development and testing command references.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [AGENT.md](file:///workspace/docs/AGENT.md) | ||
| - [DATA_MODEL.md](file:///workspace/docs/DATA_MODEL.md) | ||
| - [PRODUCTION.md](file:///workspace/docs/PRODUCTION.md) | ||
| - [DECISIONS.md](file:///workspace/docs/DECISIONS.md) | ||
|
|
||
| ## Repository Layout | ||
|
|
||
| Monorepo/workspaces: | ||
|
|
||
| - Root scripts and workspace config: [package.json](file:///workspace/package.json), [pnpm-workspace.yaml](file:///workspace/pnpm-workspace.yaml) | ||
|
|
||
| Primary code: | ||
|
|
||
| - Frontend app: [apps/web](file:///workspace/apps/web) | ||
| - Backend services: [services](file:///workspace/services) | ||
| - Shared packages: | ||
| - DB schema + client: [packages/db](file:///workspace/packages/db) | ||
| - Shared types/utilities: [packages/shared](file:///workspace/packages/shared) | ||
| - Local infra: [infra/docker](file:///workspace/infra/docker) | ||
| - Utility scripts: [scripts](file:///workspace/scripts) |
| - `src/index.ts`: bootstraps Fastify, registers routes, health checks, shared error handler/observability | ||
| - `src/env.ts`: Zod-validated environment | ||
| - `src/routes.ts` (+ `src/routes/*`): request/response schemas and handler wiring | ||
| - `src/service.ts`: the main “service layer” class that encapsulates domain logic and DB access |
| Key exports: | ||
|
|
||
| - `db`: Drizzle client bound to the schema ([client.ts](file:///workspace/packages/db/src/client.ts#L31)) | ||
| - `checkDbHealth()`: simple query-based health probe ([client.ts](file:///workspace/packages/db/src/client.ts#L34-L42)) | ||
|
|
||
| Notes: | ||
|
|
||
| - The DB client loads Docker infra defaults first (`infra/docker/.env`), then root `.env`, enabling easy local runs while still supporting overrides ([client.ts](file:///workspace/packages/db/src/client.ts#L8-L11)). |
Co-authored-by: traeagent <traeagent@users.noreply.github.com>
There was a problem hiding this comment.
2 files reviewed, 0 findings | View scores & details
Reviewed by Octopus Review, an AI-powered PR review tool.
Co-authored-by: traeagent <traeagent@users.noreply.github.com>
There was a problem hiding this comment.
3 files reviewed, 0 findings | View scores & details
Reviewed by Octopus Review, an AI-powered PR review tool.
🎯 Changes
1. New CloudMind OS Code Wiki Document
docs/CODE_WIKI.mdto centralize architectural context and implementation concepts.💡 Technical Highlights