Skip to content

Commit 547c848

Browse files
Bordaclaude
andcommitted
docs: rewrite index page and expand all plugin READMEs
- docs/index.md: full rewrite — "why this exists", detailed plugin summaries per section, "where to start" table, cross-plugin workflow examples (research→develop→oss, codemap→develop→oss, foundry→everything), contributing section - All five plugin READMEs significantly expanded and restructured - README.md: reformat tiered review pipeline as bullet list --- Co-authored-by: Claude Code <noreply@anthropic.com>
1 parent 808737d commit 547c848

81 files changed

Lines changed: 2831 additions & 1363 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.claude/README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Re-run `/foundry:init` after any plugin upgrade — rule symlinks point to versi
6666

6767
`plugins/foundry/` is the **source of truth** for all foundry configuration. The Claude Code plugin system natively exposes agents and skills; `/foundry:init` symlinks rules and `TEAM_PROTOCOL.md` into `~/.claude/` so they load on every session.
6868

69-
```
69+
```text
7070
plugins/foundry/ ← source of truth
7171
rules/*.md ←── symlinked ──→ ~/.claude/rules/*.md (init: ln -sf)
7272
TEAM_PROTOCOL.md ←── symlinked ──→ ~/.claude/TEAM_PROTOCOL.md (init: ln -sf)
@@ -91,7 +91,7 @@ plugins/foundry/ ← source of truth
9191

9292
## 📦 Plugin Architecture
9393

94-
```
94+
```text
9595
╔══════════════════════════════════╗
9696
║ 🟠 foundry [OPTIONAL] ║
9797
╟────────────────────┬─────────────╢
@@ -223,7 +223,7 @@ Each skill follows a defined topology for how it composes agents:
223223
<details>
224224
<summary><strong>`/oss:review`</strong> — parallel fan-out, then consolidation</summary>
225225

226-
```
226+
```text
227227
Tier 0: git diff --stat (mechanical gate — skips trivial diffs)
228228
Tier 1: Codex pre-pass (independent diff review, ~60s)
229229
Tier 2: 6 parallel agents — sw-engineer, qa-specialist, perf-optimizer,
@@ -237,7 +237,7 @@ Tier 2: 6 parallel agents — sw-engineer, qa-specialist, perf-optimizer,
237237
<details>
238238
<summary><strong>`/develop:feature`</strong> — sequential with inner loops</summary>
239239

240-
```
240+
```text
241241
Step 1: sw-engineer (codebase analysis)
242242
Step 2: sw-engineer (demo test — TDD contract)
243243
Step 2 review: in-context validation gate
@@ -252,7 +252,7 @@ Quality stack: linting-expert → qa-specialist → Codex pre-pass
252252
<details>
253253
<summary><strong>`/develop:fix`</strong> — reproduce-first</summary>
254254

255-
```
255+
```text
256256
Step 1: sw-engineer (root cause analysis)
257257
Step 2: sw-engineer (regression test that fails)
258258
Step 2 review: in-context validation gate
@@ -266,7 +266,7 @@ Quality stack: linting-expert → qa-specialist → Codex pre-pass
266266
<details>
267267
<summary><strong>`/develop:refactor`</strong> — test-first</summary>
268268

269-
```
269+
```text
270270
Step 1: sw-engineer + linting-expert (coverage audit, parallel)
271271
Step 2: qa-specialist (characterization tests)
272272
Step 2 review: in-context validation gate
@@ -280,7 +280,7 @@ Quality stack: linting-expert → qa-specialist → Codex pre-pass
280280
<details>
281281
<summary><strong>`/research:topic`</strong> — research-first</summary>
282282

283-
```
283+
```text
284284
web-explorer (fetch current papers/docs) → scientist (deep analysis, writes to file)
285285
→ consolidator reads findings → implementation plan
286286
(--team: multiple scientist instances on competing method families)
@@ -291,7 +291,7 @@ web-explorer (fetch current papers/docs) → scientist (deep analysis, writes to
291291
<details>
292292
<summary><strong>`/brainstorm`</strong> — conversational spec, then task breakdown</summary>
293293

294-
```
294+
```text
295295
idea mode:
296296
Step 1: context scan (Read README, Grep keywords)
297297
Step 2: AskUserQuestion (clarify, one at a time, max 10)
@@ -312,7 +312,7 @@ breakdown mode (triggered by "breakdown <tree-or-spec>"):
312312
<details>
313313
<summary><strong>`/audit`</strong> — self-mentor per file, then consolidation</summary>
314314

315-
```
315+
```text
316316
per-config-file: self-mentor (reads file, writes findings to /tmp/audit-<ts>/<file>.md)
317317
→ consolidator reads all finding files → ranked report with upgrade proposals
318318
(upgrade mode: web-explorer fetches latest Claude Code docs first)
@@ -707,7 +707,7 @@ Agent Teams is Claude Code's experimental multi-agent feature. Teams are always
707707

708708
**State files layout:**
709709

710-
```
710+
```markdown
711711
/tmp/claude-state-<session>/
712712
├── agents/<id>.json # one per active subagent (created at start, deleted at stop)
713713
├── codex/<id>.json # one per active codex plugin session
@@ -761,7 +761,7 @@ Output: JSON with token usage by model (input/output/cache), tool call counts, t
761761

762762
A lightweight hook (`hooks/statusline.js`) adds a persistent two-row status bar to every Claude Code session:
763763

764-
```
764+
```text
765765
Row 1: claude-sonnet-4-6 │ Borda.AI-Rig │ Pro ~$1.20 │ ████░░░░░░ 38% │ 💬
766766
Row 2: 🕵 2 agents (self-mentor, sw-engineer) │ 🤖 codex-rescue │ 🔧 Bash ×3 · Edit · Read ×12
767767
```
@@ -830,7 +830,7 @@ Skills check availability at runtime: `claude plugin list 2>/dev/null | grep -q
830830

831831
Runtime artifacts live at the project root in dot-prefixed dirs — separate from versioned config in `.claude/`. The dot-prefix signals "generated output, not source".
832832

833-
```
833+
```text
834834
.plans/blueprint/ ← /brainstorm spec and tree files
835835
.plans/active/ ← todo_*.md, plan_*.md
836836
.plans/closed/ ← completed plans

‎.codex/AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ Apply only if it does not require discarding local changes. If it conflicts with
293293

294294
**Naming convention:**
295295

296-
```
296+
```text
297297
<from-role>→<to-role>-<unix-timestamp>.patch
298298
```
299299

‎README.md‎

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ claude plugin install research@borda-ai-rig # ML research: topic, plan, judge,
6565
6666
**4. One-time settings merge** — run inside Claude Code:
6767

68-
```
68+
```text
6969
/foundry:init link
7070
```
7171

@@ -109,7 +109,7 @@ Each command chains agents in a defined topology — see [Common Workflow Sequen
109109
110110
## 📦 What's Here
111111
112-
```
112+
```text
113113
AI-Rig/
114114
├── plugins/
115115
│ ├── foundry/ # Base plugin: agents, hooks, audit/manage/calibrate/brainstorm/…
@@ -212,7 +212,7 @@ Skills chain naturally — the output of one becomes the input for the next.
212212
<details>
213213
<summary><strong>Bug report → fix → validate</strong></summary>
214214
215-
```
215+
```text
216216
/oss:analyse 42 # understand the issue, extract root cause hypotheses
217217
/develop:fix 42 # reproduce with test, apply targeted fix
218218
/oss:review # validate the fix meets quality standards
@@ -223,7 +223,7 @@ Skills chain naturally — the output of one becomes the input for the next.
223223
<details>
224224
<summary><strong>Performance investigation → optimize → refactor</strong></summary>
225225
226-
```
226+
```text
227227
/research:plan src/mypackage/dataloader.py # profile-first: cProfile → pick goal → wizard
228228
/develop:refactor src/mypackage/dataloader.py # extract caching layer
229229
/develop:review # review diff before commit
@@ -234,7 +234,7 @@ Skills chain naturally — the output of one becomes the input for the next.
234234
<details>
235235
<summary><strong>Code review → fix blocking issues</strong></summary>
236236
237-
```
237+
```text
238238
/oss:review 55 # 7 agent dimensions + Codex co-review
239239
/develop:fix "race condition in cache invalidation" # fix blocking issue from review
240240
/oss:review 55 # re-review after fix
@@ -245,7 +245,7 @@ Skills chain naturally — the output of one becomes the input for the next.
245245
<details>
246246
<summary><strong>New feature → implement → release</strong></summary>
247247
248-
```
248+
```text
249249
/oss:analyse 87 # understand the issue, clarify acceptance criteria
250250
/develop:feature 87 # codebase analysis, demo test, TDD, docs, review
251251
/oss:release # generate CHANGELOG entry and release notes
@@ -256,7 +256,7 @@ Skills chain naturally — the output of one becomes the input for the next.
256256
<details>
257257
<summary><strong>New OSS capability → research → implement → review</strong></summary>
258258
259-
```
259+
```text
260260
/research:topic "efficient attention for long sequences" # find SOTA methods
261261
/develop:feature "implement FlashAttention in encoder" # TDD-first implementation
262262
/develop:review # review diff before commit
@@ -268,7 +268,7 @@ Skills chain naturally — the output of one becomes the input for the next.
268268
<details>
269269
<summary><strong>Autonomous metric improvement campaign</strong></summary>
270270
271-
```
271+
```text
272272
/research:plan "increase test coverage to 90%" # interactive config wizard → program.md
273273
/research:run "increase test coverage to 90%" # run 20-iteration loop; auto-rollback on regression
274274
/research:run --resume # resume after crash or manual stop
@@ -279,7 +279,7 @@ Skills chain naturally — the output of one becomes the input for the next.
279279
<details>
280280
<summary><strong>Fuzzy idea → spec → breakdown → implement</strong></summary>
281281
282-
```
282+
```text
283283
/brainstorm "integrate OpenSpace MCP for skill evolution"
284284
# clarifying questions → 2–3 approaches → spec saved to .plans/blueprint/ → self-mentor review → approval
285285
@@ -298,7 +298,7 @@ Skills chain naturally — the output of one becomes the input for the next.
298298
<details>
299299
<summary><strong>Research SOTA → optimize toward metric</strong></summary>
300300
301-
```
301+
```text
302302
/research:topic "knowledge distillation for small models" # find best approach
303303
/research:plan "improve F1 from 0.82 to 0.87" # configure metric + guard + agent
304304
/research:run --team # parallel exploration across axes
@@ -309,7 +309,7 @@ Skills chain naturally — the output of one becomes the input for the next.
309309
<details>
310310
<summary><strong>Distill → create → audit → calibrate</strong></summary>
311311
312-
```
312+
```text
313313
/distill # analyze work patterns, suggest new agents/skills
314314
/manage create agent my-agent "..." # scaffold suggested agent
315315
/audit # verify config integrity — catch broken refs, dead loops
@@ -321,7 +321,7 @@ Skills chain naturally — the output of one becomes the input for the next.
321321
<details>
322322
<summary><strong>PR review feedback → resolve → verify</strong></summary>
323323
324-
```
324+
```text
325325
/oss:resolve 42 # auto-detect conflicts → resolve semantically → apply review comments via codex-plugin-cc
326326
/develop:review # full quality pass on all applied changes
327327
```
@@ -333,7 +333,7 @@ Skills chain naturally — the output of one becomes the input for the next.
333333
334334
Preferred flow for maintainers responding to external contributions:
335335
336-
```
336+
```text
337337
/oss:analyse 42 --reply # assess PR readiness + draft contributor reply in one step
338338
339339
# or if you need the full deep review first:
@@ -351,7 +351,7 @@ Both `--reply` flags produce the same two-part shepherd output: an overall PR co
351351
<details>
352352
<summary><strong>Agent self-improvement loop</strong></summary>
353353
354-
```
354+
```text
355355
/distill # analyze work patterns, surface what agents are missing or miscalibrated
356356
/calibrate all fast ab apply # benchmark all agents vs general-purpose baseline, apply improvement proposals
357357
/audit fix # structural sweep after calibrate changed instruction files
@@ -364,7 +364,7 @@ Both `--reply` flags produce the same two-part shepherd output: an overall PR co
364364
365365
After editing agent descriptions (manually or via `/audit fix`), verify that routing accuracy hasn't degraded:
366366
367-
```
367+
```text
368368
/audit # Check 20 flags description overlap pairs (static, fast)
369369
/calibrate routing fast # behavioral test: generates task prompts, measures routing accuracy
370370
```
@@ -376,7 +376,7 @@ Run `/calibrate routing fast` after any agent description change. Thresholds: ro
376376
<details>
377377
<summary><strong>Config maintenance — periodic health check</strong></summary>
378378
379-
```
379+
```text
380380
/audit # inspect findings + docs-sourced upgrade proposals — report only, no changes
381381
/audit upgrade # apply upgrade proposals: config changes verified, capability changes A/B tested
382382
/audit fix # full sweep + auto-fix critical and high findings
@@ -389,7 +389,7 @@ Run `/calibrate routing fast` after any agent description change. Thresholds: ro
389389
390390
MEMORY.md is injected into every message in every session. As it grows, so does the per-message token cost — compounding across every turn. Keep it lean.
391391
392-
```
392+
```text
393393
/distill lessons # promote recurring corrections into durable rules/agents/skills
394394
/distill prune # trim MEMORY.md — drop entries now covered by rules, stale facts, or superseded decisions
395395
```
@@ -401,7 +401,7 @@ Run after any session with significant corrections, or monthly as routine hygien
401401
<details>
402402
<summary><strong>Keep config current after Claude Code releases</strong></summary>
403403
404-
```
404+
```text
405405
/audit # fetches latest Claude Code docs, surfaces applicable improvements as upgrade proposals
406406
/audit upgrade # applies config proposals (correctness check) and capability proposals (calibrate A/B)
407407
/calibrate all fast # re-benchmark all agents to confirm no regression from applied changes
@@ -412,7 +412,7 @@ Run after any session with significant corrections, or monthly as routine hygien
412412
<details>
413413
<summary><strong>Release preparation</strong></summary>
414414
415-
```
415+
```text
416416
/oss:release notes v1.2.0..HEAD # generate release notes from git history
417417
```
418418
@@ -490,7 +490,13 @@ Use `rsync` when you have local customizations (extra agents, personal profiles)
490490
491491
Claude and Codex complement each other — Claude handles long-horizon reasoning, orchestration, and judgment calls; Codex handles focused, mechanical in-repo coding tasks with direct shell access.
492492
493-
Every skill that reviews or validates code uses a three-tier pipeline: **Tier 0** (mechanical `git diff --stat` gate), **Tier 1** (codex:review pre-pass, ~60s, diff-focused), **Tier 2** (specialized Claude agents). Cheaper tiers gate the expensive ones — this keeps full agent spawns reserved for diffs that actually need them. → Full architecture with skill-tier matrix: [`.claude/README.md` → Tiered review pipeline](.claude/README.md#tiered-review-pipeline)
493+
Every skill that reviews or validates code uses a three-tier pipeline:
494+
495+
- **Tier 0** (mechanical `git diff --stat` gate)
496+
- **Tier 1** (codex:review pre-pass, ~60s, diff-focused)
497+
- **Tier 2** (specialized Claude agents).
498+
499+
Cheaper tiers gate the expensive ones — this keeps full agent spawns reserved for diffs that actually need them. → Full architecture with skill-tier matrix: [`.claude/README.md` → Tiered review pipeline](.claude/README.md#tiered-review-pipeline)
494500
495501
**Why unbiased review matters / Real example**: Claude makes targeted changes with intentionality — it has a mental model of which files are "in scope". Codex has no such context: it reads the diff and the codebase independently. During one session, Claude applied a docstring-style mandate across 6 files and scored its own confidence at 0.88. The Codex pre-pass then found `skills/develop/modes/feature.md` still referencing the old style — a direct miss. The union of both passes is more complete than either alone.
496502

0 commit comments

Comments
 (0)