Skip to content
Seed & Source Docs

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

🔧 Setup & Configuration

  • onboarding/ — Complete onboarding guides
    • QUICK-SETUP.md — 5-minute setup
    • SYSTEM_ARCHITECTURE.md — System overview
    • CLI_INTEGRATION.md — CLI usage guide
    • DISCOVERY_QUESTIONS.md — Project planning questionnaire

Feature Documentation

📚 API Reference

🆘 Troubleshooting & Support

� Configuration Guides

⚙️ Operations & Deployment

  • DEPLOYMENT_RUNBOOK.md — Production deploy process, env vars, migrations, rollback, health checks, and failure remediation

📋 Release & Updates

💰 Strategy

🎯 By Use Case

”I’m new to Seed & Source”

  1. Start: README.md
  2. Then: GETTING_STARTED.md
  3. Next: onboarding/INTRODUCTION.md
  4. Setup: onboarding/QUICK-SETUP.md

”I’m an alpha client”

→ ALPHA_ONBOARDING_CHECKLIST.md — Complete step-by-step onboarding with success validation

”I want to set up a project quickly”

→ onboarding/QUICK-SETUP.md

”I want to understand the architecture”

→ onboarding/SYSTEM_ARCHITECTURE.md

”I’m having issues”

→ TROUBLESHOOTING.md → troubleshooting/FULL_STACK_SETUP_GUIDE.md — For full-stack setup issues (CORS, authentication, Docker) → troubleshooting/COMMON_ERRORS.md — Top 20 most common errors → troubleshooting/DIAGNOSTIC_COMMANDS.md — Run diagnostics to identify problems → troubleshooting/WEBHOOK_FAILURES.md — For webhook problems

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

→ FEATURE_INJECTION_GUIDE.md — Decision tree + recipes by template

”I need to set up webhooks/tunnel”

→ guides/TUNNEL_CONFIGURATION.md — Complete tunnel guide → quick_reference/TUNNEL_QUICK_REF.md — Quick command reference

”I need API documentation”

→ api/AUTH_API_REFERENCE.md — Auth endpoints and integration

”I want to use the CLI”

→ reference/cli-quick-reference.md

”I want to know about updates”

→ RELEASE_PROCESS.md

”I need feature documentation”

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

📊 Document Map

| Document | Audience | Time | Purpose | | ------------------------------------ | ----------------------- | --------- | ---------------------------------------------- | --- | ----------------------------- | ------------- | --------- | --------------------------------- | --- | -------------- | ---------- | ----- | ---------- | | README.md | Everyone | 5 min | Overview | | GETTING_STARTED.md | Beginners | 25-30 min | Zero-to-deploy guide | | ALPHA_ONBOARDING_CHECKLIST.md | Alpha clients | 25-35 min | Step-by-step onboarding checklist | | QUICK-SETUP.md | Developers | 5 min | Fast start | | INTRODUCTION.md | New users | 15 min | Understanding basics | | SYSTEM_ARCHITECTURE.md | Architects | 20 min | System design | | CLI_INTEGRATION.md | Developers | 10 min | Using the CLI | | TROUBLESHOOTING.md | Everyone | As needed | Problem solving | | COMMON_ERRORS.md | Everyone | Reference | Top 20 errors with solutions | | DIAGNOSTIC_COMMANDS.md | Developers | Reference | System health checks | | RELEASE_PROCESS.md | All | 5 min | Understanding updates | | DEPLOYMENT_RUNBOOK.md | Technical founder / dev | 20 min | Deploy, migrate, rollback, health verification | | ../strategy/MONETIZATION_STRATEGY.md | Leadership | 10 min | Canonical pricing, alpha cap, buy flow | | reference/cli-quick-reference.md | Developers | Reference | CLI command reference | | tunnel_configuration.md | Developers | 30 min | Complete ngrok tunnel setup | | tunnel_quick_ref.md | Developers | Reference | Quick tunnel commands | | LLM_STRATEGY.md | Tech leads | 15 min | AI integration | | Feature docs | Specific | Variable | Feature guides |

🔄 For CLI Display

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

Terminal window
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.md

  2. Update this INDEX.md

    • 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

FolderPurposeAudience
/User guides, onboarding, featuresCustomers, end users
/docs/plans/Checklists, project planningInternal team
/docs/architecture/Technical design decisionsDevelopers, architects
/docs/implementation/Feature implementation specsDevelopment team
/docs/strategy/Business strategyLeadership
/docs/analysis/Ideas, optimization, retrospectivesTeam discussions
/docs/management/Operations, processesManagement

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