fix: map README links to actual filenames and update section READMEs

- Fix all broken links in root README (partner-channel-strategy → Ideal Customer Profile, etc.) - Add code/ directory to repo structure tree - Update status table: Legal ✅, MCP Server ✅ MVP - Rewrite section READMEs with actual file inventories: docs/engineering/, docs/gtm/, docs/investors/, docs/legal/
2026-07-16 14:13:04 -07:00
parent 2be10ce42c
commit 3bd59b6d2b
5 changed files with 89 additions and 42 deletions
@@ -1,5 +1,22 @@
-# Engineering Folder — geolocal.io
+# Engineering — geolocal.io

-Architecture overview, MCP server design, data model, Cal.com integration, telemetry pipeline, MVP scope per vertical.
+Architecture, technical roadmap, and implementation.

-Every technical decision must trace back to NORTH_STAR.md.
+## Files
+
+| File | Description |
+|------|-------------|
+| [Technical Roadmap](./technical%20roadmap.md) | 12-week phased plan: MVP → V1 → Scale |
+
+## 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).
@@ -1,10 +1,17 @@
-# GTM Folder — geolocal.io
+# GTM — geolocal.io

-Partner-first go-to-market materials.
+Partner-first go-to-market strategy and collateral.

- Agency/CoC outreach scripts
- Onboarding flows & JSON pointer instructions
- Pricing & commission structures
- White-label & partner playbooks
+## Files

-All content here must align with NORTH_STAR.md.
+| File | Description |
+|------|-------------|
+| [Ideal Customer Profile](./Ideal%20Customer%20Profile.md) | Who we target: agencies, SEO consultants, CoCs |
+| [Channel Strategy](./ChannelStrategy.md) | 3-pronged distribution: agencies, vertical subdomains, SEO |
+| [Sales and Marketing](./Sales%20and%20marketing.md) | Playbook, messaging, funnel |
+| [Competitive Intelligence](./Competitive%20Intelligence.md) | Competitor mapping and positioning |
+| [Market Data & Analysis](./Market%20Data%20&%20Analysis.md) | TAM, SAM, SOM |
+| [Competitive Moats & Risks](./Competitive%20moats%20and%20risks.md) | Defensibility and threat analysis |
+| [Partner One-Pager](./Partner%20One-Pager.md) | Agency sell-sheet (ready to send) |
+
+All content here must align with [NORTH_STAR.md](../../NORTH_STAR.md).
@@ -1,5 +1,12 @@
-# Investors Folder — geolocal.io
+# Investors — geolocal.io

-Pitch materials, market sizing, competitive analysis, financial model sketches, and traction plan.
+Pitch materials, market sizing, financial model.

-Align everything to NORTH_STAR.md.
+## Files
+
+| File | Description |
+|------|-------------|
+| [Market Data & Analysis](./Market%20Data%20&%20Analysis.md) | $98.8B TAM, consumer AI adoption trends |
+| [Business and Financial Model](./Business%20and%20financial%20model.md) | Revenue model, unit economics, projections |
+
+Align everything to [NORTH_STAR.md](../../NORTH_STAR.md).
@@ -1,5 +1,13 @@
-# Legal Folder — geolocal.io
+# Legal — geolocal.io

-Risk assessment, IP notes, data flow diagrams (including bi-directional verification), partnership agreement skeletons, compliance considerations.
+Compliance, data flow, partnership agreements, IP notes.

-Must reference NORTH_STAR.md for principles.
+## Files
+
+| File | Description |
+|------|-------------|
+| [Data Flow & Privacy](./Data%20Flow%20&%20Privacy.md) | Data collection, storage, sharing, GDPR/CCPA |
+| [Partnership Agreement Skeleton](./Partnership%20Agreement%20Skeleton.md) | Template for agency/CoC partnerships |
+| [IP Notes](./IP%20Notes.md) | Trademark, telemetry ownership, open-source strategy |
+
+Must reference [NORTH_STAR.md](../../NORTH_STAR.md) for principles.