Documentation Index

Public Documentation Index

Purpose: User-facing documentation shown in CLI and to customers. Audience: End users, developers, and client organizations. Last Updated: March 4, 2026

---

📚 Quick Navigation

🚀 Getting Started

• README — Overview and introduction to Seed & Source
• Getting Started Guide — Zero-to-deploy guide (beginner-friendly)
• Onboarding Quick Setup — Fast 5-minute setup guide
• Onboarding Introduction — Detailed introduction
• CLI Quick Reference — Quick reference for CLI commands

🔧 Setup & Configuration

• onboarding/ — Complete onboarding guides
  • Quick Setup — 5-minute setup
  • System Architecture — System overview
  • CLI Integration — CLI usage guide
  • Discovery Questions — Project planning questionnaire

Feature Documentation

• Feature Injection Guide ⭐ NEW — Complete guide to feature injection (Commerce, Auth, Admin, Tunnel) with decision trees and recipes
• Auth API Reference — Auth API documentation (GitHub OAuth Device Flow)
• Commerce API Reference — Commerce API documentation (Shopify, Stripe, QR codes)
• Tunnel Configuration Guide — Complete ngrok tunnel setup and troubleshooting

📚 API Reference

• Auth API Reference — Complete Auth API documentation (GitHub OAuth Device Flow)
• Commerce API Reference — Complete Commerce API documentation (Shopify, Stripe, QR codes)

🆘 Troubleshooting & Support

• Troubleshooting Overview — Common issues and solutions
• Full Stack Setup Guide ⭐ NEW — Comprehensive full-stack setup guide (React + Rails/Python) with real error messages
• Common Errors ⭐ NEW — Top 20 errors with real examples and solutions
• Diagnostic Commands ⭐ NEW — Quick diagnostic commands and health checks
• Webhook Failures — Webhook debugging guide
• Onboarding FAQ — Onboarding FAQ

� Configuration Guides

• Tunnel Configuration Guide — Complete ngrok tunnel setup and troubleshooting
• Tunnel Quick Reference — Quick reference for tunnel commands

💰 Strategy

• Monetization Strategy — Canonical pricing tiers, alpha cap, buy flow, and post-alpha roadmap

---

🎯 By Use Case

”I’m new to Seed & Source”

1. Start: README
2. Then: Getting Started Guide
3. Next: Onboarding Introduction
4. Setup: Onboarding Quick Setup

”I want to set up a project quickly”

→ Onboarding Quick Setup

”I want to understand the architecture”

→ System Architecture

”I’m having issues”

→ Troubleshooting Overview → Full Stack Setup Guide — For full-stack setup issues (CORS, authentication, Docker) → Common Errors — Top 20 most common errors → Diagnostic Commands — Run diagnostics to identify problems → Webhook Failures — For webhook problems

”I want to inject a feature (Commerce, Auth, Admin, Tunnel)”

→ Feature Injection Guide — Decision tree + recipes by template

”I need to set up webhooks/tunnel”

→ Tunnel Configuration Guide — Complete tunnel guide → Tunnel Quick Reference — Quick command reference

”I need API documentation”

→ Auth API Reference — Auth endpoints and integration

”I want to use the CLI”

→ CLI Quick Reference

”I need feature documentation”

→ onboarding/ (LLM, PDF, pipelines, etc.)

---

📊 Document Map

Document	Audience	Time	Purpose
README	Everyone	5 min	Overview
Getting Started Guide	Beginners	25-30 min	Zero-to-deploy guide
Onboarding Quick Setup	Developers	5 min	Fast start
Onboarding Introduction	New users	15 min	Understand core flow
System Architecture	Architects	20 min	System design
CLI Integration	Developers	10 min	Using the CLI
Troubleshooting Overview	Everyone	As needed	Problem solving
Common Errors	Everyone	Reference	Top 20 errors with solutions
Diagnostic Commands	Developers	Reference	System health checks
CLI Quick Reference	Developers	Reference	CLI command reference
Tunnel Configuration Guide	Developers	30 min	Complete ngrok tunnel setup
Tunnel Quick Reference	Developers	Reference	Quick tunnel commands
Feature Injection Guide	Builders	Variable	Feature recipes by template
Monetization Strategy	Leadership	10 min	Canonical pricing and buy flow

---

🔄 For CLI Display

Future CLI Integration: These docs will be displayed in the interactive CLI menu:

sscli docs                    # Show this index
sscli docs quick-setup        # Show quick setup guide
sscli docs troubleshooting    # Show troubleshooting
sscli docs                    # Show public docs only

---

📝 Adding New Public Docs

When creating public documentation:

1. Add to appropriate folder:

   • Getting started? → /onboarding/
   • Client-specific? → Internal-only docs (not in public portal)
   • Bug fixes? → Update Troubleshooting

2. Update this index

   • Add to relevant section
   • Include in “By Use Case” if applicable
   • Update “Document Map” with time estimate

3. Format requirements:

   • Clear title and purpose at top
   • Target audience stated
   • Estimated read time
   • Links to related docs
   • Markdown format

---

🔗 Internal vs. Public

This folder (public/): User-facing, customer-ready, shown in CLI Other /docs/ folders: Internal planning, architecture, analysis

Folder	Purpose	Audience
/	User guides, onboarding, features	Customers, end users
/docs/plans/	Checklists, project planning	Internal team
/internal-docs/non-public/architecture/	Technical design decisions	Internal team
/docs/implementation/	Feature implementation specs	Development team
/docs/strategy/	Business strategy	Leadership
/docs/analysis/	Ideas, optimization, retrospectives	Team discussions
/docs/management/	Operations, processes	Management

---

Status: 🟢 Active Maintained by: Seed & Source Review Cycle: As new features released