Commit 16114f2
authored
DOJ-3712: Update IDT CLAUDE.md with toolkit contract + overlay protocol + symbolic refs (2/2) (#20)
* DOJ-3712: Add CLAUDE.md documenting toolkit contract for agents
Single-file addition (CLAUDE.md, ~520 lines) covering:
- What This Toolkit Is — multi-tenant generic plugin pitch + Base+Overlay
framing (DOJ-3706); separates Layer 1 (cmi5/xAPI invariants), Layer 2
(pedagogy generic), Layer 3 (consumer voice — never in IDT base).
- Skill overlays — discovery + invocation + tier defaults +
Layer 1 invariant validator; §5.4 findings-shaped procedure for
audit/review commands; ${CLAUDE_PLUGIN_ROOT} defensive note (DOJ-3775
§6.1) for direct-CLI invocation; canonical consumer references
(dojo-academy academy-philosophy + content-standards) per DOJ-3710.
- Symbolic references — [course:<slug>] / [module:.../...] convention
per DOJ-3713; resolver contract; DojoOS rendering example with
path-aware routing forward-compat (DOJ-3714); explicit anti-patterns
(no hardcoded URLs, no relative .md paths, no unknown type prefixes).
- Repo composability — three-expectation contract for consumer repos
(declare dependency, provide content layout, optionally ship overlays);
catalogue of representative consumer types.
- CI workflow — DOJ-3774 lint pipeline (3 standalone scripts at
scripts/ci/, ~7s typical run); rationale for standalone-vs-heredoc;
security note (read-only permissions, pinned action SHAs, no
github.event.* in shell).
- Conventions for agents — Linear-not-GitHub, branch/PR/squash rules,
Greptile 5/5 with no skip-the-review, CI gating, Spanish accents,
multi-tenant discipline test, forbidden words/patterns.
- Linear issue map — DOJ-3705 → DOJ-3712 chain plus DOJ-3713/3714/3774/
3775 cross-references.
- Related repos — dojo-academy (canonical consumer), dojo-os (renderer
+ symbolic-ref resolver owner), srd-framework / business-model-toolkit
/ ux-research-toolkit (sibling plugins).
Companion to dojo-academy/CLAUDE.md updated in parallel (separate PR).
Verified locally:
- python3 scripts/ci/check_json_schemas.py — 3 schemas valid
- python3 scripts/ci/check_frontmatter.py — 64 valid, 2 skipped
- python3 scripts/ci/check_agent_references.py — 19 agents indexed,
all references resolve
Created by Claude Code on behalf of @andres
* DOJ-3712: Address Greptile findings on CLAUDE.md
Fixes 5 findings from initial Greptile pass (3/5 → expected 5/5):
1. Symbolic refs section (DOJ-3713 Proposed/MUST mismatch): MUST → SHOULD,
added explicit advisory note. Agents prefer symbolic refs in new content
but MUST NOT rewrite hardcoded URLs while DOJ-3713 is under proposal.
Convention upgrades to MUST once DOJ-3713 ships.
2. Greptile gate self-contradiction: clarified the policy as "5/5 functional
on first review pass" with non-blocking re-score (per
feedback_dont_wait_for_greptile_rereviews.md). Removed the apparent
conflict between "5/5 before merge" and "no waiting for re-review".
3. lesson: prefix disambiguation: added explicit rule that segment 2 of the
slug-path being the literal token `docs` distinguishes workbook lessons
from standard module-nested lessons. Two examples included; resolvers
MUST implement consistently.
4. Linear issue map: added DOJ-3829 as its own row (was previously only
inline-referenced from the DOJ-3709 row).
5. Branch naming: parameterized `andres/...` to `<username>/...` with a note
that the literal `andres/` prefix in linear-setup.json reflects the
current primary contributor and should be updated by future contributors.
Re-verified locally:
- python3 scripts/ci/check_json_schemas.py — 3 schemas valid
- python3 scripts/ci/check_frontmatter.py — 64 valid, 2 skipped
- python3 scripts/ci/check_agent_references.py — 19 agents, all references resolve
Created by Claude Code on behalf of @andres1 parent 73eb619 commit 16114f2
1 file changed
Lines changed: 550 additions & 0 deletions
0 commit comments