Skip to content

docs: add comprehensive architecture document (ARCHITECTURE_v1.md) #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
forketyfork merged 3 commits into from
Feb 8, 2026
Merged

docs: add comprehensive architecture document (ARCHITECTURE_v1.md) #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad77352
docs: add comprehensive architecture document (ARCHITECTURE_v1.md)
claude Feb 7, 2026
820d89c
docs: restructure architecture doc for usability
forketyfork Feb 8, 2026
f8dbf74
docs: note c.zig exception in dependency rules
forketyfork Feb 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Guidance for any code agent working on the Architect repo. Keep this file instru

## Documentation

- Architecture overview lives in `docs/architecture.md`. Read it to understand the app architecture.
- Architecture overview lives in `docs/ARCHITECTURE.md`. Read it to understand the app architecture.
- Configuration reference lives in `docs/configuration.md`. Consult it for config.toml and persistence.toml structure.

## Quick Workflow
Expand Down Expand Up @@ -121,7 +121,7 @@ The `<= len` pattern is only correct when `pos` represents a position *after* pr
## Documentation Hygiene (REQUIRED)
- **ALWAYS** update documentation when making changes. This is not optional.
- Update `README.md` for any user-facing changes: new features, configuration options, keyboard shortcuts, or behavior changes.
- Update `docs/architecture.md` when adding new components, modules, or changing the system structure.
- Update `docs/ARCHITECTURE.md` when adding new components, modules, or changing the system structure.
- Update `docs/configuration.md` when adding, removing, or changing configuration options in `config.toml` or `persistence.toml`.
- Keep this `CLAUDE.md` aligned when workflows or automation expectations change.
- Documentation updates should be part of the same PR as the code changes.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Common settings include font family, theme colors, and grid font scale. The grid
## Documentation

* [`docs/ai-integration.md`](docs/ai-integration.md): set up Claude Code, Codex, and Gemini CLI hooks for status notifications (includes `architect notify`, `architect hook ...`, and timestamped backups).
* [`docs/architecture.md`](docs/architecture.md): architecture overview and system boundaries.
* [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md): architecture overview and system boundaries.
* [`docs/configuration.md`](docs/configuration.md): detailed configuration reference for `config.toml` and `persistence.toml`.
* [`docs/development.md`](docs/development.md): build, test, and release process.
* [`CLAUDE.md`](CLAUDE.md): agent guidelines for code assistants.
Expand Down
Loading