Deduplicate entry points and templates
CLAUDE.md and AGENTS.md (now a symlink) shrink to a pointer at the bootstrap, which absorbs the rule-editing instructions. The two identical per-tool templates merge into rules/ai/AGENT.template.md. README drops the read path duplicated from the bootstrap. The web-visual-baseline starter CSS/HTML duplicated assets/view.css and is removed in favor of the vendored assets. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
27
README.md
27
README.md
@@ -4,21 +4,8 @@ Shared engineering rules library for Go web projects.
|
||||
|
||||
Add as a git submodule to any project — agents (Claude, Codex) will read the rules automatically.
|
||||
|
||||
## Agent Read Path
|
||||
|
||||
Agents should not read the whole submodule by default.
|
||||
|
||||
Start here:
|
||||
|
||||
1. `bible/AGENT-BOOTSTRAP.md`
|
||||
2. `bible-local/README.md`
|
||||
3. Only the relevant files in `bible-local/architecture/`, `bible-local/decisions/`, and
|
||||
`bible/rules/patterns/...`
|
||||
|
||||
The bootstrap file contains:
|
||||
- the always-on core contracts
|
||||
- a router from task type to relevant contracts
|
||||
- the default rule to skip unrelated contracts
|
||||
Agents start at `AGENT-BOOTSTRAP.md` — it defines the read path, always-on contracts,
|
||||
and the task router. Nothing in this README duplicates it.
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -35,21 +22,15 @@ git submodule update --remote bible
|
||||
```
|
||||
AGENT-BOOTSTRAP.md — first file agents should read; contains the full contract router
|
||||
rules/patterns/<topic>/ — one contract.md per topic (plus optional README.md with examples)
|
||||
rules/ai/claude/ — CLAUDE.template.md for new projects
|
||||
rules/ai/codex/ — AGENTS.template.md for new projects
|
||||
rules/ai/AGENT.template.md — template for new projects; copy as both CLAUDE.md and AGENTS.md
|
||||
scripts/lint.sh — consistency checks (router coverage, broken links)
|
||||
```
|
||||
|
||||
The list of contracts is not duplicated here. The single source of truth for what exists
|
||||
and when to read it is the router in `AGENT-BOOTSTRAP.md`.
|
||||
|
||||
## Project Setup
|
||||
|
||||
Each project needs:
|
||||
- `bible/` — this submodule
|
||||
- `bible-local/` — project-specific architecture (data model, API, ADL)
|
||||
- `CLAUDE.md` + `AGENTS.md` — point agents to the bootstrap file and to `bible-local/`
|
||||
- `CLAUDE.md` + `AGENTS.md` — copies of `rules/ai/AGENT.template.md` pointing agents to the bootstrap
|
||||
|
||||
See `rules/ai/claude/CLAUDE.template.md` for a ready-made template.
|
||||
See `rules/ai/codex/AGENTS.template.md` for a ready-made Codex template.
|
||||
See `rules/patterns/go-project-bible/contract.md` for what goes in `bible-local/`.
|
||||
|
||||
Reference in New Issue
Block a user