Skip to content

Commit e8692a5

Browse files
authored
docs: add monorepo project catalog readme (#310)
## Summary This PR adds a new root `README.md` that explains all canonical projects in this monorepo. ## What Changed - added a repository overview section for the top-level domains (`apps`, `cmds`, `crates`, `servers`, `protos`, `packaging`, `docs`) - added a compact project catalog table for all 12 canonical projects - documented each project with `Project ID`, `Purpose`, `Owned Paths`, `Status`, and `Primary Docs` - added status tags based on documented project state (`active`, `active (partial)`, `active + planned`) - added a documentation contract note clarifying that `docs/` is the source of truth ## Validation - verified all 12 project IDs appear exactly once in the table - verified all linked `docs/*.md` paths exist - cross-checked project purpose and status labels against `docs/project-*.md` ## Out of Scope - no code, proto, or runtime behavior changes - no contract updates under `docs/` (README references only)
1 parent e10d245 commit e8692a5

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# OSS Monorepo
2+
3+
This repository hosts multiple products and shared tooling across apps, CLIs, servers, Rust crates, and Connect RPC contracts.
4+
5+
## Repository Overview
6+
7+
- `apps/`: User-facing apps (Next.js, React Native, desktop frontends)
8+
- `cmds/`: Go command tools and workflow CLIs
9+
- `crates/`: Rust crates and Rust-based tooling
10+
- `servers/`: Backend services and APIs
11+
- `protos/`: Shared Connect RPC proto contracts
12+
- `packaging/`: Package manager and release automation assets
13+
- `docs/`: Canonical contracts, project indexes, and domain-level documentation
14+
15+
## Project Catalog
16+
17+
| Project ID | Purpose | Owned Paths | Status | Primary Docs |
18+
| --- | --- | --- | --- | --- |
19+
| `cargo-mono` | Cargo subcommand for Rust monorepo lifecycle management, including version bump and publish orchestration. | `crates/cargo-mono` | `active` | [project-cargo-mono](docs/project-cargo-mono.md), [crates-cargo-mono-foundation](docs/crates-cargo-mono-foundation.md) |
20+
| `nodeup` | Rust-based Node.js version manager with deterministic channel resolution, shell completions, and shim execution. | `crates/nodeup` | `active` | [project-nodeup](docs/project-nodeup.md), [crates-nodeup-foundation](docs/crates-nodeup-foundation.md) |
21+
| `derun` | Go CLI that preserves terminal fidelity for AI-agent workflows and bridges MCP output transport. | `cmds/derun` | `active` | [project-derun](docs/project-derun.md), [cmds-derun-foundation](docs/cmds-derun-foundation.md) |
22+
| `ttl` | TTL compiler contract for task graph validation, execution, and cache-aware runtime behavior. | `cmds/ttlc` | `active` | [project-ttl](docs/project-ttl.md), [cmds-ttl-foundation](docs/cmds-ttl-foundation.md), [cmds-ttl-language-contract](docs/cmds-ttl-language-contract.md) |
23+
| `mpapp` | Expo React Native app for mobile workflows with stable platform behavior and documented device capability usage. | `apps/mpapp` | `active` | [project-mpapp](docs/project-mpapp.md), [apps-mpapp-foundation](docs/apps-mpapp-foundation.md) |
24+
| `devkit` | Next.js micro-app host platform with shared shell contracts and scaffold-first route conventions. | `apps/devkit` | `active` | [project-devkit](docs/project-devkit.md), [apps-devkit-foundation](docs/apps-devkit-foundation.md) |
25+
| `devkit-commit-tracker` | Commit-level metric tracking mini app with time-series visualization and PR comparison reporting. | `apps/devkit/src/apps/commit-tracker`<br>`servers/commit-tracker` | `active (partial: collector deferred)` | [project-devkit-commit-tracker](docs/project-devkit-commit-tracker.md), [apps-devkit-commit-tracker-web-app-foundation](docs/apps-devkit-commit-tracker-web-app-foundation.md) |
26+
| `devkit-remote-file-picker` | Signed-URL upload mini app for local file or camera input with direct object-storage upload and callbacks. | `apps/devkit/src/apps/remote-file-picker`<br>`servers/remote-file-picker` | `active (partial: production adapter deferred)` | [project-devkit-remote-file-picker](docs/project-devkit-remote-file-picker.md), [apps-devkit-remote-file-picker-foundation](docs/apps-devkit-remote-file-picker-foundation.md) |
27+
| `thenv` | Secure `.env` sharing workflow across CLI, server, and Devkit web console components. | `cmds/thenv`<br>`servers/thenv`<br>`apps/devkit/src/apps/thenv` | `active` | [project-thenv](docs/project-thenv.md), [cmds-thenv-cli-foundation](docs/cmds-thenv-cli-foundation.md), [servers-thenv-server-foundation](docs/servers-thenv-server-foundation.md), [apps-thenv-web-console-foundation](docs/apps-thenv-web-console-foundation.md) |
28+
| `serde-feather` | Size-first serialization contract split between runtime core and derive-macro crates. | `crates/serde-feather`<br>`crates/serde-feather-macros` | `active` | [project-serde-feather](docs/project-serde-feather.md), [crates-serde-feather-core-foundation](docs/crates-serde-feather-core-foundation.md), [crates-serde-feather-macros-foundation](docs/crates-serde-feather-macros-foundation.md) |
29+
| `public-docs` | Mintlify-based public documentation site for user-facing product and platform content. | `apps/public-docs` | `active` | [project-public-docs](docs/project-public-docs.md), [apps-public-docs-foundation](docs/apps-public-docs-foundation.md) |
30+
| `dexdex` | Connect RPC-first orchestration platform for CLI coding agents across desktop app, control plane, worker plane, and shared proto contracts. | `apps/dexdex`<br>`servers/dexdex-main-server`<br>`servers/dexdex-worker-server`<br>`protos/dexdex/v1` | `active + planned (poller auto-remediation)` | [project-dexdex](docs/project-dexdex.md), [apps-dexdex-desktop-app-foundation](docs/apps-dexdex-desktop-app-foundation.md), [servers-dexdex-main-server-foundation](docs/servers-dexdex-main-server-foundation.md), [servers-dexdex-worker-server-foundation](docs/servers-dexdex-worker-server-foundation.md), [protos-dexdex-v1-contract](docs/protos-dexdex-v1-contract.md) |
31+
32+
## Documentation Contract
33+
34+
- `docs/` is the source of truth for project contracts and implementation documents.
35+
- Every project is defined by `docs/project-<id>.md` plus one or more domain contract documents.
36+
- When ownership, interfaces, or runtime behavior changes, update the relevant `docs/` contracts in the same change.
37+
- Start from [docs/README.md](docs/README.md) for the canonical documentation catalog.

0 commit comments

Comments
 (0)