sourceharbor
SourceHarbor Docs
If the README is the storefront, this page is the lobby directory.
SourceHarbor has several layers, but the public entry should stay simple:
- See the outcome in under a minute
- Take the no-boot tour
- Run the shortest truthful path
- Inspect the proof
- Dive into architecture only when you need it
Why Builders Keep Reading
This is the shortest honest explanation for why the repo feels more product-shaped than script-shaped:
| Builder question | Fastest truthful answer | Where to verify it |
|---|---|---|
| Can I use this with Codex or Claude Code right now? | Yes, through the existing MCP and HTTP API surfaces. | mcp-quickstart.md, builders.md |
| What about OpenClaw? | There is now a first-cut local OpenClaw starter pack, but it still stays outside the primary front door and outside marketplace positioning. | compat/openclaw.md, builders.md, public-skills.md |
| Is the AI story grounded or just decorative copy? | Search, Ask, proof, runtime truth, and project status are kept on the same story line. | proof.md, project-status.md, runtime-truth.md |
| Is there anything worth revisiting after the first run? | Yes: watchlists, trends, bundles, playground, and use-case pages form the compounder layer. | runtime-truth.md, samples/README.md |
Start By Goal
| If you want to… | Start here | What you get |
|---|---|---|
| Understand the product in 3 minutes | README.md | The product story, quick value, and star-worthy reasons |
| Get the fastest no-boot preview | see-it-fast.md | The command center, digest feed, and job trace path without setup |
| Run the shortest truthful path | start-here.md | A result-first local flow ending in jobs, feed, and proof |
| Open the MCP front door | mcp-quickstart.md | Startup, representative tools, and the relation between MCP, API, and Web |
| Build on top of SourceHarbor | builders.md | How Codex, Claude Code, OpenClaw, generic MCP clients, API consumers, public packages, and starter packs fit the current repo truth |
| Open the public starter surface | public-skills.md | Public compatibility docs, starter prompts, and runnable examples |
| Check public distribution status | public-distribution.md | What is bundle-ready, what is submit-ready, and which final steps stay human-only |
| Grab the public asset pack | media-kit.md | Exact social preview path, tracked public visuals, listing copy hooks, and teaser-video prep notes |
| Try the read-only sample playground | samples/README.md | Clearly labeled sample corpus and demo surfaces |
| Read the site capability ledger | site-capability.md | Current read-only capability boundaries, next low-risk deepening work, and human-only edges |
| Open the compounder layer | runtime-truth.md | How watchlists, trends, bundles, and sample surfaces fit the current truth |
| See what is done vs still a bet | project-status.md | The shortest truthful status board for delivered, gated, sample-only, and future-direction surfaces |
| Check what is publicly provable today | proof.md | Commands, boundaries, and evidence layers |
| See what is still a future-direction spike | 2026-03-31-agent-autopilot-spike.md and 2026-03-31-hosted-readiness-spike.md | What is worth exploring next without pretending it already exists |
| Understand the moving parts | architecture.md | API, worker, MCP, web, and shared surfaces |
| See how verification works | testing.md | Local checks, CI checks, and smoke paths |
| Compare SourceHarbor to other repo shapes | compare.md | Differentiation, trade-offs, and why this repo is product-shaped |
| Scan common questions fast | faq.md | Adoption, scope, hosted-vs-source-first, and proof boundaries |
Read In Layers
Layer 1: Product Surface
Layer 2: Public Proof
Layer 2.5: Builder Entry
Layer 3: System Map
Layer 4: Community And Contribution
First-Hop Route
If you only have one minute, trust these four documents first:
README.mdfor the front door and product shapedocs/start-here.mdfor the first real rundocs/proof.mdfor the evidence ladder and proof boundarydocs/testing.mdfor the testing and CI contract
Truth Route At A Glance
| Surface | Role | Reading rule |
|---|---|---|
| README.md | Front door | Start here for product shape and navigation, not for commit-sensitive verdicts |
| start-here.md | First real run | Use this when you want the shortest truthful local path |
| proof.md | Proof ladder | Use this to understand what is locally provable, what needs remote proof, and where the public boundary stops |
docs/generated/* |
Render-only pointers | Follow these only as signposts into runtime-owned evidence, never as the current verdict itself |
.agents/Plans/* |
Historical execution archive | Treat these as archived planning context, not as the current truth route for public readers |