Skip to content

CLAUDE.md

Latest commit

 

History

History
84 lines (64 loc) · 2.66 KB

CLAUDE.md

File metadata and controls

84 lines (64 loc) · 2.66 KB
Raw

install-obsidian — Project Hub

Operational hub for AI agents working in this repository. Stable/non-negotiable rules live in ./.claude/rules/. Generic doc-update skill lives in ./.claude/skills/updating-docs/.

Read First

  • [[README]] — project overview
  • [[INSTALL]] — execution flow for AI agents
  • [[PRINCIPLES]] — design rules
  • [[.claude/skills/updating-docs]] — generic doc-update skill shipped to target repos (read this when working on the skill itself or Phase 3 step 3.6)

Directory Tree (Authoritative)

install-obsidian/
├── .claude/
│   ├── rules/
│   │   ├── coding-behavior-rules.md
│   │   ├── security-rules.md
│   │   └── stable-rules.md
│   └── skills/
│       └── updating-docs/
│           └── SKILL.md
├── PHASES/
├── TEMPLATES/
├── CHANGELOG.md
├── CONTRIBUTING.md
├── INSTALL.md
├── LICENSE
├── PRINCIPLES.md
├── README.md
└── decisions.md

Rule Layers

  1. Stable rules (immutable): read all files in ./.claude/rules/ first.
    • [[.claude/rules/stable-rules]] — project-wide stable rules
    • [[.claude/rules/security-rules]] — security constraints
    • [[.claude/rules/coding-behavior-rules]] — Karpathy-inspired coding behavior (think before coding, simplicity, surgical changes, goal-driven execution)
  2. Operational rules (editable): use this CLAUDE.md for workflow/navigation.
  3. Task-specific instructions: follow user instructions in current session.
  4. Hybrid strategy: preserve installer core requirements; apply llm-wiki-inspired practices as a complementary layer.
  5. Shipped skills: ./.claude/skills/updating-docs/SKILL.md is the generic doc-update skill that the installer copies to every target repo (see [[PHASES/03-implement]] step 3.6).

Definition of Done (Session)

  • Requested change is implemented with minimal scope.
  • Related docs/instructions are updated when behavior changed.
  • Verification commands were run for affected stack:
    • TypeScript: tsc --noEmit
    • Otherwise: run equivalent existing validation commands in repo
  • Commit is scoped to one issue/change set.
  • decisions.md updated when design/strategy decisions were made.
  • CLAUDE.md reviewed and updated to reflect current project state.

Session Closeout

At the end of every session, run a final pass:

  1. Update CLAUDE.md to match current project state
  2. Update decisions.md for any new lasting decisions
  3. Confirm links and paths still point to existing files

Related

  • [[INSTALL]]
  • [[PRINCIPLES]]
  • [[CHANGELOG]]
  • [[decisions]]