|
| 1 | +# Ferrite v0.3.1 — Mermaid Wave 2, Embeds, Multi-Window, Data UX & Polish - AI Context |
| 2 | + |
| 3 | +## Rules (DO NOT UPDATE) |
| 4 | +- **Implementation sessions:** follow **Implementation Phase Rules** below only. |
| 5 | +- **Update sessions:** follow **Update Phase Rules** below only when you receive the update handover prompt. |
| 6 | +- Only do the task specified; do not start the next task or go over scope. |
| 7 | +- Run `cargo test` after code changes to verify tests pass. |
| 8 | +- Follow existing code patterns and conventions. |
| 9 | +- Use Context7 MCP to fetch library documentation when needed (resolve library ID first, then fetch docs). Task operations use **`cyclopsctl tasks` CLI only**. |
| 10 | + |
| 11 | +## Implementation Phase Rules |
| 12 | +When working from **`current-handover-prompt.md`** (the normal case for every cyclopsctl task cycle): |
| 13 | + |
| 14 | +- **DO:** Implement and test only the current parent task described in the handover. |
| 15 | +- **DO:** Run `cargo test` before finishing; meet the task test strategy. |
| 16 | +- **DO:** Use Context7 MCP for up-to-date library documentation when implementing unfamiliar APIs or frameworks. |
| 17 | +- **DO NOT:** Read `prd.md` during cyclopsctl cycles — task scope, details, and test strategy are already in this handover. |
| 18 | +- **DO NOT:** Mark tasks done or change task status. |
| 19 | +- **DO NOT:** Run `cyclopsctl tasks next`, rewrite `current-handover-prompt.md`, or edit `ai-context.md`. |
| 20 | +- **DO NOT:** Create or update docs in `docs/`, or edit `docs/index.md`. |
| 21 | +- **DO NOT:** Edit `update-handover-prompt.md`. |
| 22 | + |
| 23 | +Task completion and all documentation updates happen only in the **update phase** (`update-handover-prompt.md`). |
| 24 | + |
| 25 | +## Update Phase Rules |
| 26 | +When `update-handover-prompt.md` is provided (after implementation in the same agent session): |
| 27 | + |
| 28 | +- **DO:** Follow every step in `update-handover-prompt.md`. |
| 29 | +- **DO:** Use `cyclopsctl tasks list pending --project-root G:\DEV\markDownNotepad` and pick the **lowest numeric parent id** for the next handover — not `cyclopsctl tasks next` (priority can skip ahead). |
| 30 | +- **DO:** Rewrite `current-handover-prompt.md` for the **next** task (this is the only time that file may change). |
| 31 | +- **DO:** Update `ai-context.md` project memory per update handover step 2 (key facts only, not a changelog). |
| 32 | +- **DO:** Use `cyclopsctl tasks` with `--project-root G:\DEV\markDownNotepad` for all task commands (see Environment in the handover). |
| 33 | +- **DO:** Document by feature (e.g., `auth-layer.md`), not by task number; update `docs/index.md` when adding documentation. |
| 34 | +- **DO NOT:** Re-implement or extend the task you just finished unless tests are broken. |
| 35 | + |
| 36 | +## Conventions |
| 37 | +- **Documentation:** Feature-based names in `docs/` (e.g., `auth-layer.md`), not `task-1.md`. Update `docs/index.md` in the update phase only. |
| 38 | +- **Tasks:** `cyclopsctl tasks` CLI only from agents. |
| 39 | + |
| 40 | +## Handover Files |
| 41 | +| File | Who may edit | When | |
| 42 | +|------|----------------|------| |
| 43 | +| `current-handover-prompt.md` | Update-phase agent only | After implementation | |
| 44 | +| `update-handover-prompt.md` | Human / template only | Never edited by agents | |
| 45 | +| `ai-context.md` | Update-phase agent only | Every update phase — project memory bullets (see update handover step 2) | |
| 46 | + |
| 47 | +## Tech Stack |
| 48 | +Rust |
| 49 | + |
| 50 | +## Architecture & Data Model |
| 51 | +See `prd.md` for product architecture. This file captures agent workflow rules and where project artifacts live. |
| 52 | + |
| 53 | +## Where Things Live |
| 54 | +| Want to... | Look in... | |
| 55 | +|------------|------------| |
| 56 | +| Product requirements | `prd.md` | |
| 57 | +| Current implementation handover | `current-handover-prompt.md` | |
| 58 | +| Post-task update rules | `update-handover-prompt.md` | |
| 59 | +| Documentation map | `docs/index.md` | |
| 60 | +| Tasks and complexity | `.cyclopsctl/tasks/tasks.json`, `.cyclopsctl/reports/complexity-report.json` | |
| 61 | +| Cyclopsctl config | `cyclopsctl.toml` | |
0 commit comments