Codebase healthPhase 1 — Documentation & setup
Per-directory README + AGENTS.md
Status: Partially implemented — workspace-wide Rust rules and several crate-level orientation files are already current; five crates in crates/ still have no README.md or AGENTS.md
Shipped facts
crates/AGENTS.md already documents the workspace-wide Rust rules for the current crate layout: Rust 2024 self-named module files (no mod.rs), the tests.rs convention, naming, and the lint/supply-chain baseline. No stale pre-split src/ language remains there. Seven of the nineteen crates/* directories have their own orientation file: jackin-capsule, jackin-build-meta, jackin-pr-trailers, jackin-protocol, jackin-term, and jackin-tui each carry a README.md, and jackin-tui-lookbook carries an AGENTS.md. docs/AGENTS.md is also current for the Fumadocs site layout.
Target directories still missing an orientation file
| Directory | README or AGENTS.md should say |
|---|---|
crates/jackin/ | CLI binary crate: command dispatch, app context, command handlers, and root integration tests. |
crates/jackin-runtime/ | Container bootstrap pipeline, instance lifecycle, launch pipeline, DinD sidecar management, isolation, and runtime tests. |
crates/jackin-console/ | Operator console TUI state, input/update, screens, services, and shared console components. |
crates/jackin-config/ | Config loading, persistence, editing, schema versions, and migrations. |
crates/jackin-env/ | Operator environment resolution, 1Password references, picker metadata, and launch diagnostics. |
Rules for crate guidance
- Keep each orientation file short: entrypoints and invariants, not a second codebase map.
- Do not create or recommend
mod.rs; crates use Rust 2024 self-named module files such asfoo.rsplusfoo/tests.rs. - Point durable source navigation to Codebase Map and root
PROJECT_STRUCTURE.md.