agentleFS
yashyaadavyashyaadav/arcadedb/docs/CLAUDE.md

arcadedb

CLAUDE.md1 starsChanged 5 months agoApache-2.0View on GitHub

Directory rules for the design docs. Inherits the root CLAUDE.md. No decision lands without an ADR that states its reasoning, and no assumption stands without a docs/assumptions.md entry. This is a CLAUDE.md convention and a CI check. When you make a choice or rest on an assumption while working anywhere in this repo, update these docs in the same change. - One file per decision, next free NNNN, kebab-case title. - Use 0000-template.md (or the new-adr skill). - Required sections:…

The file

We split this CLAUDE.md into the rules it gives an agent

4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use 0000-template.md (or the new-adr skill).

    line 15
  2. Very specific:

    After writing, add a row to the ADR index in architecture.md and link any assumptions it rests on.

    line 19
  3. Distinctive:

    Don't edit a decided ADR's decision — supersede it with a new ADR.

    line 23
  4. Distinctive:

    Every row records: assumption · why we chose it · impact if wrong · confidence · validation owner / when · linked ADR(s).

    line 27

≈ “Common” is an estimate: at least 1 in 5 of the 27,641 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

CLAUDE.md — docs/

Directory rules for the design docs. Inherits the root CLAUDE.md.

The enforced rule

No decision lands without an ADR that states its reasoning, and no assumption stands without a docs/assumptions.md entry. This is a CLAUDE.md convention and a CI check. When you make a choice or rest on an assumption while working anywhere in this repo, update these docs in the same change.

ADRs (docs/adr/NNNN-*.md)

  • One file per decision, next free NNNN, kebab-case title.
  • Use 0000-template.md (or the new-adr skill).
  • Required sections: Context · Assumptions it rests on · Options considered (with pros/cons) · Decision · Reasoning (why this beats the alternatives) · Consequences · Status · Review-trigger.
  • After writing, add a row to the ADR index in architecture.md and link any assumptions it rests on.
  • Status values: Proposed · Accepted · Superseded by ADR-NNNN · Deprecated. Don't edit a decided ADR's decision — supersede it with a new ADR.

Assumptions log (docs/assumptions.md)

Every row records: assumption · why we chose it · impact if wrong · confidence · validation owner / when · linked ADR(s). Convert relative dates to absolute. When validated/invalidated, update Status + the affected ADR(s).

HLD vs LLD

  • architecture.md is the High-Level Design (ships in the CTO package). Keep it the single end-to-end narrative + diagrams + ADR index.
  • lld.md (Low-Level Design) is authored after CTO sign-off (Phase 0): per-module/resource specs, variable/API schemas, CIDR/IAM/KMS detail. Do not start lld.md until the CTO approves.

Diagrams

Mermaid, inline in the markdown (renders on GitHub). Keep them in sync with the IaC — a diagram that lies is worse than none.

Runbooks (docs/runbooks/)

Each operational runbook has a matching skill in .claude/skills/ (1:1 map). claude-code-operations.md is the "operating this platform with Claude Code" guide handed to the ops team.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.