Skip to content

Latest commit

 

History

History
103 lines (94 loc) · 7.51 KB

File metadata and controls

103 lines (94 loc) · 7.51 KB

Repository Structure

This file documents the iSparto repository layout. The tree evolves Wave by Wave as new modules land or existing ones reshape — this file is the authoritative source, not the README. The README used to embed the full tree inline, but as of v0.7.5 it points here so the README can stay focused on the framework's pitch while this file carries the detail.

When a Wave adds a new top-level file or directory, or renames an existing one, update this file in the same commit as the structural change.

Layout

iSparto/
├── README.md                  ← English entry point (pitch + installation + quick start)
├── README.zh-CN.md            ← Chinese-language entry point
├── CLAUDE.md                  ← Project instructions for Claude Code (Tier 1 System Prompt Layer)
├── CONTRIBUTING.md            ← Contribution guidelines
├── settings.example.json      ← Reference template for project-level .claude/settings.json
├── CLAUDE-TEMPLATE.md         ← Template for generating new project CLAUDE.md
├── LICENSE
├── .gitignore
├── VERSION                    ← Current version (semver)
├── CHANGELOG.md               ← Release notes
├── bootstrap.sh               ← Thin entry point (version resolve + checksum verify)
├── install.sh                 ← Main installer (versioned per release)
├── isparto.sh                 ← Local stub (upgrade / uninstall / version)
├── .github/
│   ├── workflows/
│   │   └── ci.yml             ← CI gate (syntax, shellcheck, guardian self-tests on macOS + Ubuntu, repo guardians, installer smoke)
│   └── ISSUE_TEMPLATE/        ← GitHub issue templates
├── scripts/
│   ├── release.sh             ← Automated release (bump version → changelog → tag → gh release)
│   ├── language-check.sh      ← Four-tier language guardian (Tier 1 / Tier 2 CJK scan + Principle 1 heuristic)
│   ├── policy-lint.sh         ← Information Layering Policy guardian (C-layer ceremonial wrapper detector, v1)
│   ├── doctor-check.sh        ← 7-check environment health script invoked by /doctor-isparto
│   ├── gh-account-guard.sh    ← gh account mid-session guard (runs immediately before `gh pr create`)
│   ├── session-health.sh      ← /start-isparto session-opening health preview
│   ├── plan-md-contract-check.sh ← Mechanical plan.md / session-log / CHANGELOG separation detector
│   └── check-command-rename.sh   ← v0.9.0 command-rename guardian
├── lib/
│   ├── snapshot.sh            ← Snapshot / restore engine (factory-reset capability)
│   └── patch-settings.py      ← settings.json hook patcher (equivalence-based dedup, FR-52)
├── hooks/
│   └── process-observer/      ← Real-time interception hook scripts + rule files
├── commands/
│   ├── start-isparto.md       ← Start-working command
│   ├── end-isparto.md         ← End-working command
│   ├── plan-isparto.md        ← Planning command
│   ├── init-isparto.md        ← Initialize project command
│   ├── env-isparto.md         ← Environment readiness check
│   ├── migrate-isparto.md     ← Migrate existing project to iSparto
│   ├── restore-isparto.md     ← Restore project to a previous snapshot
│   ├── security-isparto.md    ← Milestone-level full security audit
│   ├── doctor-isparto.md      ← Installation health check (wraps scripts/doctor-check.sh)
│   └── release-isparto.md     ← Release flow (wraps scripts/release.sh)
├── agents/
│   ├── independent-reviewer.md       ← Product-technical alignment blind reviewer (Codex CLI runtime — see note below)
│   └── process-observer-audit.md     ← Post-session compliance audit role (Claude Code sub-agent)
├── templates/
│   ├── product-spec-template.md
│   ├── tech-spec-template.md
│   ├── design-spec-template.md
│   ├── plan-template.md
│   └── gitignore-security-baseline.md   ← Security .gitignore baseline
├── assets/
│   └── *.svg                          ← SVG assets used by the READMEs
└── docs/
    ├── product-spec.md        ← Product spec (iSparto's own, for self-bootstrapping)
    ├── plan.md                ← Development plan by Wave
    ├── roadmap.md             ← Long-range v1.x / v2.x product roadmap
    ├── session-log.md         ← Auto-generated session metrics (created by /end-isparto)
    ├── case-studies.md        ← End-to-end dogfooding case collection
    ├── repo-structure.md      ← This file
    ├── dogfood-log.md         ← Subjective dogfooding experience log
    ├── concepts.md            ← Core concepts (decoupling, Wave, file ownership)
    ├── collaboration-mode.md  ← Collaboration mode (mode selection, lifecycle, protocols)
    ├── security.md            ← Security audit system (three-layer defense)
    ├── user-guide.md          ← User interaction guide
    ├── roles.md               ← Role definitions + Codex prompt templates
    ├── workflow.md            ← Full development workflow + branching + Codex integration
    ├── configuration.md       ← Global configuration + adaptation + multi-device sync
    ├── troubleshooting.md     ← Common troubleshooting
    ├── process-observer.md    ← Process Observer subsystem reference
    ├── design-decisions.md    ← Design decision records
    ├── independent-review.md  ← Independent Reviewer report archive
    ├── observation-period/    ← v0.8.0 observation-period audit artifacts
    ├── zh/
    │   └── quick-start.md     ← Chinese quick-start (Tier 3 user-facing entry)
    └── design-principles/
        ├── information-layering-policy.md   ← A / B / C layering policy
        ├── conversation-style.md            ← Conversation style guide
        └── a-layer-peer-review.md           ← A-layer Peer Review protocol

Tier annotation (per CLAUDE.md Documentation Language Convention)

  • Tier 1 (System Prompt Layer, English-only): CLAUDE.md, CLAUDE-TEMPLATE.md, commands/, agents/, templates/, hooks/, bootstrap.sh, install.sh, isparto.sh, scripts/, lib/.
  • Tier 2 (Reference Documentation, English-only): All files under docs/ except Tier 4 artifacts and docs/zh/.
  • Tier 3 (User-facing entry, bilingual): README.md, README.zh-CN.md, docs/zh/quick-start.md, CONTRIBUTING.md.
  • Tier 4 (Historical artifacts, frozen): docs/session-log.md, docs/plan.md, docs/dogfood-log.md, and historical entries in CHANGELOG.md. (The docs/framework-feedback-*.md pattern was retired 2026-04-17 per the Single TODO source rule; see CLAUDE.md Development Rules.)

Runtime note for agents/

independent-reviewer.md is the only agent invoked via OpenAI Codex CLI (codex exec) in a tmux pane — its frontmatter uses runtime: codex-cli instead of model:. The other agent (process-observer-audit.md) is a Claude Code sub-agent spawned via the Task tool. This runtime split is intentional: IR's value depends on cross-provider training-distribution independence from Lead's Claude — see configuration.md for rationale.

See CLAUDE.md > Documentation Language Convention for the full rationale and the language-check guardian behavior.