Documentation is organized by topic, not by app. Each doc covers one cross-cutting concern (workflow, workspace, service API, schema, etc.). To understand a single app, use the relevant topic docs and the per-app service API file.
| Topic | Doc | Purpose |
|---|---|---|
| Onboarding | Onboarding.md | First-day orientation: mental model, app roles, data dependencies, where patterns differ. |
| Workflow | Workflow.md | Main application workflow, execution order, and project details. |
| Architecture | Architecture_data_flow.md | Data flow (sources → collectors → DB / workspace → Pinecone), orchestration diagram, per-app component map. |
| Add a collector | How_to_add_a_collector.md | Checklist: new command, registration, tests, docs. |
| Core API | Core_public_API.md | Stable core imports: collectors, error classification. |
| Operations | operations/ | Group: shared I/O (GitHub, Discord, etc.) used by multiple apps. Index in operations/README.md. |
| → GitHub | operations/github.md | Clone, push, fetch file, create PR/issue/comment; token use. |
| → DiscordChatExporter | operations/discord_chat_exporter.md | Install CLI, workspace path, .env for Tyrrrz exporter used by Discord ingestion. |
| Workspace | Workspace.md | Workspace layout and usage for file processing (workspace/<app>/...). |
| Schema | Schema.md | Database schema and table relationships. |
| Development | Development_guideline.md | Development setup, app requirements, and step-by-step workflow. |
| Testing | README.md, Development_guideline.md | How to run tests (pytest), coverage, and when to run them. |
| Deployment | Deployment.md | CI/CD pipeline, environment secrets (SSH_HOST, SSH_USER, SSH_PRIVATE_KEY; optional SSH_PORT), server setup, and deploy script behavior. |
| Contributing | Contributing.md | Service layer (single place for writes) and contributor guidelines. |
| Service API | Service_API.md | API reference and index for all service layer functions. |
| Service API (per app) | service_api/ | Per-app service API docs (name, description, parameters, return types, validation). |
Operations = external integrations used by many apps (not the same as Service API, which is for DB writes). See operations/README.md for the full list and when to add one.
- GitHub: operations/github.md —
core.operations.github_ops(clone, push, PR, issue, comment). - Discord (ingestion): operations/discord_chat_exporter.md — DiscordChatExporter CLI; service_api/discord_activity_tracker.md — commands, sync layout, Pinecone. (Notifications / webhooks: add an operations doc when implemented.)
- Service layer (create/update/delete): service_api/ → e.g. github_activity_tracker.md.
- Operations (GitHub, Discord, …): operations/README.md and the docs in operations/.
- Workspace (file paths, JSON cache): Workspace.md — which apps use workspace and the folder layout.
- Schema (models): Schema.md.
- Workflow (when an app runs): Workflow.md.