| Doc | For | Description |
|---|---|---|
| README | Everyone | Project overview, features, tech stack |
| Quick Start | Developers | Get Upstream Pulse running locally |
| Architecture | Developers | How the system works — components, data flow, schema, API reference |
| Doc | Description |
|---|---|
| Workers & Jobs | BullMQ queues, sync strategy, job triggers, monitoring |
| Database Backups | S3 backup/restore, CronJobs, failure scenarios |
| GitHub API Usage | Rate limits, capacity estimates, known limitations |
| Doc | Description |
|---|---|
| Adding an Org | How to add a new upstream org to the registry |
| Tracked Projects | Currently tracked orgs and planned additions |
| Doc | Description |
|---|---|
| Contributing Guide | PR workflow, coding standards, project structure |
| Code of Conduct | Contributor Covenant 2.1 |