You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/prompts/code-review.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Before reviewing, consult the directory index in `CLAUDE.md` to identify relevan
22
22
23
23
## Agent skills
24
24
25
-
When performing code reviews, load and use agent skills from `.agents/skills/`. Apply the skill mapping defined in [agent-skills.md](../../agent-docs/docs/references/agent-skills.md) (both "By file type" and "By import" tables) to the changed lines in the PR diff.
25
+
When performing code reviews, load and use agent skills from `.agents/skills/`. Apply the skill mapping defined in [agent-skills.md](../../agent-docs/references/agent-skills.md) (both "By file type" and "By import" tables) to the changed lines in the PR diff.
-**Reference real paths.** Always cite actual file paths as evidence (e.g., `packages/core/src/`).
80
80
-**No duplication.** If information exists in one document, link to it from others.
81
81
-**No invention.** Only document what you can verify from actual files.
82
-
-**Never use advisory language in agent instructions.** Use prohibition framing and state consequences. See [writing-agent-instructions.md](../../agent-docs/docs/references/writing-agent-instructions.md).
82
+
-**Never use advisory language in agent instructions.** Use prohibition framing and state consequences. See [writing-agent-instructions.md](../../agent-docs/references/writing-agent-instructions.md).
83
83
- ONLY modify files under `agent-docs/` and `CLAUDE.md` at the root. Modifying files outside this set will cause an infinite workflow loop.
84
84
- Do NOT modify `CLAUDE.md`.
85
85
86
86
### ADR vs docs boundary
87
87
88
-
ADRs record **why** a decision was made (the problem, the alternatives, the chosen option, and the trade-offs accepted). Operational details about **how** the decision is implemented belong in `agent-docs/docs/`.
88
+
ADRs record **why** a decision was made (the problem, the alternatives, the chosen option, and the trade-offs accepted). Operational details about **how** the decision is implemented belong in `agent-docs/`.
89
89
90
90
-**Belongs in an ADR:** the problem that motivated the decision, options evaluated, which option was chosen and why, architectural trade-offs accepted.
91
-
-**Belongs in `agent-docs/docs/`:** file paths and storage locations, URL rewriting patterns, CLI commands and flags, permissions and access controls, step-by-step operational procedures, server start/build commands.
91
+
-**Belongs in `agent-docs/`:** file paths and storage locations, URL rewriting patterns, CLI commands and flags, permissions and access controls, step-by-step operational procedures, server start/build commands.
92
92
93
93
Examples:
94
94
95
-
-**Good ADR sentence:** "Evidence is stored on an orphan branch so GitHub issue links remain stable across runs. See [ci-cd.md](../docs/references/ci-cd.md) for operational details."
95
+
-**Good ADR sentence:** "Evidence is stored on an orphan branch so GitHub issue links remain stable across runs. See [ci-cd.md](../references/ci-cd.md) for operational details."
96
96
-**Bad ADR sentence:** "Evidence files are pushed to the `dogfood-evidence` branch using `git push --force`, and URLs are rewritten from `./screenshots/` to `https://raw.githubusercontent.com/...`."
97
97
98
-
**Never put operational details (commands, paths, configs, permissions, URL patterns) into an ADR.** State the decision and its rationale, then link to the relevant `agent-docs/docs/` file for implementation specifics. Operational content in ADRs drifts from the actual implementation and misleads agents into following stale procedures instead of reading the source of truth.
98
+
**Never put operational details (commands, paths, configs, permissions, URL patterns) into an ADR.** State the decision and its rationale, then link to the relevant `agent-docs/` file for implementation specifics. Operational content in ADRs drifts from the actual implementation and misleads agents into following stale procedures instead of reading the source of truth.
99
99
100
100
### CLAUDE.md requirements
101
101
102
102
CLAUDE.md must stay between 80–150 lines. It must contain:
103
103
104
104
1.**Purpose** — 1–2 short paragraphs identifying the repository.
105
-
2.**How to Navigate** — table linking to `agent-docs/ARCHITECTURE.md` and `agent-docs/docs/` categories.
105
+
2.**How to Navigate** — table linking to `agent-docs/ARCHITECTURE.md` and `agent-docs/` categories.
106
106
3.**"If You Are Working On…"** — routing table mapping tasks to documents.
107
107
108
-
If any section grows too large, extract it into an `agent-docs/docs/` file and replace with a link.
108
+
If any section grows too large, extract it into an `agent-docs/` file and replace with a link.
-[deferred-registrations.md](./agent-docs/docs/design/deferred-registrations.md) — Two-phase registration, conditional routes/nav based on data, feature flags, or LaunchDarkly
22
-
-[cross-module-communication.md](./agent-docs/docs/design/cross-module-communication.md) — Event bus (pub/sub), plugins, shared types
-[deferred-registrations.md](./agent-docs/design/deferred-registrations.md) — Two-phase registration, conditional routes/nav based on data, feature flags, or LaunchDarkly
22
+
-[cross-module-communication.md](./agent-docs/design/cross-module-communication.md) — Event bus (pub/sub), plugins, shared types
Copy file name to clipboardExpand all lines: agent-docs/ARCHITECTURE.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,12 +31,12 @@ For detailed patterns and APIs, read the design docs linked below. This section
31
31
32
32
-**FireflyRuntime** — Central runtime object (`initializeFirefly()`). Manages module registration, routes, navigation, event bus, logging, env vars, feature flags, and plugins.
33
33
-**Modules** — Domain-specific units exporting a register function (`ModuleRegisterFunction`). Autonomous — they never import from other modules.
34
-
-**Two-Phase Registration** — (1) Initial registration at bootstrap, (2) deferred registration re-runs when global data or feature flags change. See [deferred-registrations.md](./docs/design/deferred-registrations.md).
35
-
-**AppRouter** — Wraps React Router, assembles routes from all modules, orchestrates data fetching lifecycle. See [routing-and-navigation.md](./docs/design/routing-and-navigation.md).
36
-
-**Global Data Fetching** — Built on TanStack Query (`usePublicDataQueries`, `useProtectedDataQueries`). See [data-fetching.md](./docs/design/data-fetching.md).
37
-
-**Route Types** — Protected (default), Public, Hoisted, Nested. See [routing-and-navigation.md](./docs/design/routing-and-navigation.md).
34
+
-**Two-Phase Registration** — (1) Initial registration at bootstrap, (2) deferred registration re-runs when global data or feature flags change. See [deferred-registrations.md](./design/deferred-registrations.md).
35
+
-**AppRouter** — Wraps React Router, assembles routes from all modules, orchestrates data fetching lifecycle. See [routing-and-navigation.md](./design/routing-and-navigation.md).
36
+
-**Global Data Fetching** — Built on TanStack Query (`usePublicDataQueries`, `useProtectedDataQueries`). See [data-fetching.md](./design/data-fetching.md).
37
+
-**Route Types** — Protected (default), Public, Hoisted, Nested. See [routing-and-navigation.md](./design/routing-and-navigation.md).
38
38
-**Environment Variables** — Runtime-attached (not `process.env`). Registered via `initializeFirefly()` or `runtime.registerVariable()`.
39
-
-**Cross-Module Communication** — Event bus (pub/sub), plugins, shared types. See [cross-module-communication.md](./docs/design/cross-module-communication.md).
39
+
-**Cross-Module Communication** — Event bus (pub/sub), plugins, shared types. See [cross-module-communication.md](./design/cross-module-communication.md).
- The dogfood session can discover issues outside the fixed page list, providing broader coverage.
35
35
- AI-driven tests are less deterministic than scripted tests. False positives (AI misreads the UI) are possible but expected to be rare for binary PASS/FAIL outcomes.
36
36
- Both workflows use `agent-browser install --with-deps` and `pnpm serve-endpoints` (production-like build). The dogfood session takes longer (~5–10 min including build and QA time) due to its exploratory nature vs the smoke test's fixed page list.
37
-
- Dogfood evidence is stored on the `dogfood-evidence` orphan branch so GitHub issue links remain stable across runs. See [ci-cd.md](../docs/references/ci-cd.md#dogfood-workflow) for operational details.
37
+
- Dogfood evidence is stored on the `dogfood-evidence` orphan branch so GitHub issue links remain stable across runs. See [ci-cd.md](../references/ci-cd.md#dogfood-workflow) for operational details.
38
38
- Dogfood findings are filed as GitHub issues for human triage — the workflow does not block PRs or deployments.
Copy file name to clipboardExpand all lines: agent-docs/odr/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,5 +25,5 @@
25
25
| Decision | ODR |
26
26
|---|---|
27
27
| Skill SKILL.md body keeps only critical patterns; everything else lives in reference files. Body should not grow past ~250 lines. |[0008](./0008-skill-body-reference-split.md)|
28
-
| CLAUDE.md uses a single Memory Index with keyword summaries — never a separate routing table. Section anchors are added only for files over ~80 lines with distinct, high-frequency sub-tasks. Never add foler links to category headings. Keep the file under ~55 lines. |[0010](./0010-claude-md-progressive-disclosure-design.md)|
28
+
| CLAUDE.md uses a single Memory Index with keyword summaries — never a separate routing table. Section anchors are added only for files over ~80 lines with distinct, high-frequency sub-tasks. Never add folder links to category headings. Keep the file under ~55 lines. |[0010](./0010-claude-md-progressive-disclosure-design.md)|
0 commit comments