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/
This commit is contained in:
Ty
@@ -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 |
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user