Instruction file imported from victorabarros/ura-bot (
.cursor/rules/docs-sync.mdc). Copyright stays with the author.
Docs Sync
The docs/ folder is the source of truth for the rewrite. Any code change that affects
the items below must include a corresponding docs update in the same commit.
| You changed… | Update… |
|---|---|
| HTTP routes or auth rules | docs/API.md |
| Environment variables | docs/CONFIGURATION.md + .env.example |
| Tracked stocks, post timing, message format, or LLM persona | docs/DOMAIN.md |
Layer responsibilities or ISocialService interface |
docs/agents/ARCHITECTURE.md |
| A known anti-pattern is fixed or a new one is discovered | docs/agents/ANTI-PATTERNS.md |
| A 3rd-party integration changes (endpoints, auth, SDK) | docs/3rd-parties/<provider>.md |
Definition of Done checklist
Before declaring a task complete, verify:
- All affected doc files updated
-
.env.examplehas a key for every new env var (no value) - No new route was added without an entry in
docs/API.md - No platform client was added without an entry in
docs/CONFIGURATION.md - Fan-out uses
Promise.allSettled, notPromise.all - Every required env var throws at startup if missing