From 3bd59b6d2bb95f9d9db542eb2790718bb9cd9a06 Mon Sep 17 00:00:00 2001 From: Ty Date: Thu, 16 Jul 2026 14:13:04 -0700 Subject: [PATCH] fix: map README links to actual filenames and update section READMEs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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/ --- README.md | 60 +++++++++++++++++++++----------------- docs/engineering/README.md | 23 +++++++++++++-- docs/gtm/README.md | 21 ++++++++----- docs/investors/README.md | 13 +++++++-- docs/legal/README.md | 14 +++++++-- 5 files changed, 89 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index ed7f949..cfec620 100644 --- a/README.md +++ b/README.md @@ -28,40 +28,48 @@ The major platforms (Google, Yelp, OpenAI) are building MCP infrastructure to se ### For Partners (Agencies, SEO Consultants, Chambers) -1. Read the **[Partner & Channel Strategy](./docs/gtm/partner-channel-strategy.md)** to understand the opportunity. -2. Review the **[Partner One-Pager](./docs/gtm/partner-one-pager.md)** for a concise sell-sheet. -3. Contact us to get started. +1. Read the **[Ideal Customer Profile](./docs/gtm/Ideal%20Customer%20Profile.md)** to understand who we target. +2. Review the **[Channel Strategy](./docs/gtm/ChannelStrategy.md)** and **[Sales and Marketing](./docs/gtm/Sales%20and%20marketing.md)** for the playbook. +3. Use the **[Partner One-Pager](./docs/gtm/Partner%20One-Pager.md)** as your sell-sheet. ### For Investors 1. Read the **[North Star](./NORTH_STAR.md)** document for our vision and principles. -2. Review the **[Market Data & Analysis](./docs/investors/market-data-analysis.md)** for the opportunity size. -3. Explore the **[Business & Financial Model](./docs/investors/business-financial-model.md)** and **[Competitive Moats & Risks](./docs/investors/competitive-moats-risks.md)** for our defensible position. +2. Review the **[Market Data & Analysis](./docs/investors/Market%20Data%20&%20Analysis.md)** for the opportunity size. +3. Explore the **[Business and Financial Model](./docs/investors/Business%20and%20financial%20model.md)** and **[Competitive Moats & Risks](./docs/gtm/Competitive%20moats%20and%20risks.md)** for our defensible position. ### For Developers & Engineers -1. Read the **[Product & Technical Roadmap](./docs/engineering/product-technical-roadmap.md)** for our phased implementation plan. -2. Review the **[MCP Server Architecture](./docs/engineering/mcp-server-architecture.md)** for technical details. -3. Check the **[Deployment Guide](./docs/engineering/deployment-guide.md)** for setup instructions. +1. Read the **[Technical Roadmap](./docs/engineering/technical%20roadmap.md)** for our phased implementation plan. +2. Explore the **[code/](./code/)** directory for the MCP server implementation. +3. See **[package.json](./code/package.json)** for dependencies and scripts. ## Repository Structure + +``` geolocal-io/ -├── NORTH_STAR.md # Single source of truth for vision & principles -├── README.md # This file -├── docs/ -│ ├── investors/ # Pitch narrative, market, financials, moat -│ ├── legal/ # Risks, IP, data flows, compliance notes -│ ├── engineering/ # Architecture, MCP design, MVP scope, data model -│ ├── gtm/ # Partner (agency/CoC) outreach, onboarding, pricing, playbooks -│ └── early-thinking/ # Raw conversation history and initial explorations -└── (future: code/, assets/) - - -## The North Star - -Everything we build must follow a single principle: **make it dead simple for a partner to deploy an MCP endpoint for a local business, and make that endpoint compelling enough that AI agents prefer it.** - -Our North Star document defines the "what," "why," "what if," and "when" with clarity and conviction. It anchors all product decisions, fundraising conversations, and go-to-market execution. +├── NORTH_STAR.md # Single source of truth for vision & principles +├── README.md # This file +├── code/ # MCP server implementation (TypeScript) +│ ├── src/ +│ │ ├── index.ts # Server entry point (stdio transport) +│ │ ├── mcp-server.ts # Tool registration (5 MCP tools) +│ │ ├── config.ts # Environment configuration +│ │ ├── manifest-generator.ts # /.well-known/mcp-server JSON +│ │ ├── db/ # PostgreSQL schema + seed data +│ │ ├── tools/ # get_business_info, get_hours, etc. +│ │ └── routes/ # Multi-tenant gateway +│ ├── package.json +│ ├── tsconfig.json +│ ├── Dockerfile +│ └── railway.json +└── docs/ + ├── investors/ # Market data, financial model + ├── gtm/ # ICP, channel strategy, partner one-pager + ├── engineering/ # Technical roadmap + ├── legal/ # Data flow, partnership agreement, IP notes + └── early-thinking/ # Raw conversation history and initial explorations +``` ## Status @@ -73,7 +81,7 @@ Our North Star document defines the "what," "why," "what if," and "when" with cl | **Business & Financial Model** | ✅ Complete | | **Product & Technical Roadmap** | ✅ Complete | | **GTM Strategy** | ✅ Complete | -| **Legal & Compliance** | ⬜ In progress | -| **Code / Implementation** | ⬜ Not started | +| **Legal & Compliance** | ✅ Complete | +| **MCP Server (code/)** | ✅ MVP — 5 tools, TypeScript, Railway-ready | diff --git a/docs/engineering/README.md b/docs/engineering/README.md index ff42b2a..9907689 100644 --- a/docs/engineering/README.md +++ b/docs/engineering/README.md @@ -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. \ No newline at end of file +## 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). diff --git a/docs/gtm/README.md b/docs/gtm/README.md index 81113fa..6277d79 100644 --- a/docs/gtm/README.md +++ b/docs/gtm/README.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. \ No newline at end of file +| 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). diff --git a/docs/investors/README.md b/docs/investors/README.md index 840af84..d75c0eb 100644 --- a/docs/investors/README.md +++ b/docs/investors/README.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. \ No newline at end of file +## 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). diff --git a/docs/legal/README.md b/docs/legal/README.md index c9a3066..1c6e822 100644 --- a/docs/legal/README.md +++ b/docs/legal/README.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. \ No newline at end of file +## 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.