docs: Phase A repo structure — archive, product, kebab-case
- Move copilot history and CSV to docs/archive/ - Add docs/product/ (SSP, intermediate, genre packs) and engineering/adrs/ - Rename all spaced/special-char doc paths to kebab-case - Nest competitive GTM under docs/gtm/competitive/ - Point README and NORTH_STAR at CANONICAL_STRATEGY - Leave code/ unchanged for later monorepo Phase B
This commit is contained in:
@@ -1,22 +1,12 @@
|
||||
# Engineering — geolocal.io
|
||||
# Engineering
|
||||
|
||||
Architecture, technical roadmap, and implementation.
|
||||
Architecture, roadmap, and implementation notes.
|
||||
|
||||
## Files
|
||||
| Doc | Purpose |
|
||||
|-----|---------|
|
||||
| [technical-roadmap.md](./technical-roadmap.md) | Phased technical plan (align with strategy when they diverge) |
|
||||
| [adrs/](./adrs/) | Architecture decision records |
|
||||
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| [Technical Roadmap](./technical%20roadmap.md) | 12-week phased plan: MVP → V1 → Scale |
|
||||
**Operating priorities** come from [Canonical Strategy](../strategy/CANONICAL_STRATEGY.md) (§10). When this folder and the strategy disagree, fix one of them deliberately.
|
||||
|
||||
## Code
|
||||
|
||||
The MCP server implementation lives in the repo root [`code/`](../../code/) directory:
|
||||
|
||||
- **`src/index.ts`** — Server entry point (stdio transport)
|
||||
- **`src/mcp-server.ts`** — Tool registration (5 MCP tools)
|
||||
- **`src/tools/`** — Individual tool implementations
|
||||
- **`src/db/`** — PostgreSQL schema + seed data
|
||||
- **`src/manifest-generator.ts`** — `/.well-known/mcp-server` JSON manifest
|
||||
- **`railway.json`** + **`Dockerfile`** — Deployment config
|
||||
|
||||
Every technical decision must trace back to [NORTH_STAR.md](../../NORTH_STAR.md).
|
||||
Current implementation lives in `code/` (MCP MVP). A later monorepo phase moves that to `apps/mcp-gateway`.
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
# Architecture Decision Records (ADRs)
|
||||
|
||||
Short, dated decisions so we do not re-litigate the same choices.
|
||||
|
||||
## Format
|
||||
|
||||
Each ADR: `NNNN-short-title.md`
|
||||
|
||||
```markdown
|
||||
# NNNN — Title
|
||||
|
||||
**Status:** proposed | accepted | superseded
|
||||
**Date:** YYYY-MM-DD
|
||||
|
||||
## Context
|
||||
## Decision
|
||||
## Consequences
|
||||
```
|
||||
|
||||
## Index
|
||||
|
||||
| ADR | Title | Status |
|
||||
|-----|-------|--------|
|
||||
| — | *(none yet)* | — |
|
||||
|
||||
Candidates worth writing soon: HTTP vs stdio for production MCP; Cal.com orchestration vs rebuild booking; monorepo layout (Phase B).
|
||||
Reference in New Issue
Block a user