docs(roadmap): re-bake codebase-readability audit and scope bollard phase 1#366
Merged
Merged
Conversation
…hase 1 Refresh the codebase-readability program's May 2026 baseline against today's tree (LOC, file counts, mega-function sizes, //! coverage, duplication counts) and add a trend caution showing every metric except "Dockerfile" literals regressed since the original audit. Update cargo-workspace-split's LOC reference to match. Resolve the contradiction between bollard-migration (Deferred) and open review findings #13 and #14 (still Medium-active) by carving out a Phase 1 scope (lifecycle, cleanup, inspect via Bollard) with named files, out-of-scope items, and acceptance criteria. Back-link findings #13 and #14 to the new phase, and update the roadmap overview bullet to match. Co-authored-by: Amp <amp@ampcode.com> Signed-off-by: Alexey Zhokhov <alexey@zhokhov.com> Amp-Thread-ID: https://ampcode.com/threads/T-019e366a-cbc8-773f-a56e-bfb203bb2718
donbeave
added a commit
that referenced
this pull request
May 17, 2026
…hase 1 (#366) ## Summary Re-bakes the codebase-readability program's May 2026 baseline against today's tree (LOC, file counts, mega-function sizes, `//!` coverage, duplication counts) and adds a trend caution showing every metric except `"Dockerfile"` literals regressed since the original audit — making the gap between "audit happened" and "extraction work scheduled" visible to anyone landing on the page. Cargo workspace split's LOC reference is updated to match. Separately, resolves the standing contradiction between the deferred Bollard migration and two still-Medium open review findings (#13 cleanup string-matching, #14 inspect-collapse-to-not-found) by carving out a concrete Phase 1 scope (lifecycle, cleanup, inspect via Bollard) with named files, out-of-scope items, and acceptance criteria; the open findings catalog now back-links both items to that Phase 1 so the two pages agree on ownership. ## What's deferred (follow-up PRs) - `jackin-daemon` phase-order section so the four reactive-daemon leaves (daemon, live-auth-sync, attention-prompts, host-bridge, desktop hub) have one canonical sequencing reference. - `reproducibility-pinning` operator-review pass (the page has been "agent brainstorm, not yet reviewed" for a long time). - `multi-runtime-support` "Remaining Work" bullets — split into acceptance-criteria-bearing leaves or annotate each bullet with a definition of done. - Bollard Phase 2 (`docker build`, interactive `docker run -it` via Bollard) — kept deferred per the original "incremental is pragmatic" rationale. ## Verify locally ### Checkout Paste this first to bypass the `tirith` paste scanner for the rest of the session: ```sh export TIRITH=0 ``` Then paste the checkout block: ```sh mkdir -p "$HOME/Projects/jackin-project/test" cd "$HOME/Projects/jackin-project/test" if [ ! -d jackin/.git ]; then git clone https://github.com/jackin-project/jackin.git fi cd jackin mise trust git fetch -f origin docs/roadmap-rebake-audit-and-bollard-phase1:refs/remotes/origin/docs/roadmap-rebake-audit-and-bollard-phase1 git checkout -B docs/roadmap-rebake-audit-and-bollard-phase1 refs/remotes/origin/docs/roadmap-rebake-audit-and-bollard-phase1 ``` ### Documentation ```sh cd docs bun install --frozen-lockfile bunx astro sync bunx tsc --noEmit bun run build bun run check:repo-links bun run dev ``` Astro serves at `http://localhost:4321/`. Pages to walk: **http://localhost:4321/reference/roadmap/codebase-readability/** UPDATED roadmap page in the *Internals → Roadmap → Codebase health* sidebar group. New "Trend since the original May 2026 audit" caution Aside at the top should render under the five numbered goals, and the per-module health table plus Tier A/B/C tables should show the refreshed LOC numbers (largest file 7593L, `fn run` 1186L). The "Current metrics" table near the bottom now has three columns (today / original May 2026 audit / pre-audit) instead of two. **http://localhost:4321/reference/roadmap/bollard-migration/** UPDATED roadmap page in the *Internals → Roadmap → Infrastructure* sidebar group. Status now reads "Partially scoped"; new "Open Review Findings This Resolves" and "Phased Plan" sections should render with the in-scope files, out-of-scope deferrals, and acceptance criteria for Phase 1. **http://localhost:4321/reference/roadmap/open-review-findings/** UPDATED roadmap page in the same Infrastructure sidebar group. Findings #13 and #14 should each end with "Scoped for the Bollard migration Phase 1." and the link should resolve. **http://localhost:4321/reference/roadmap/cargo-workspace-split/** UPDATED roadmap page in the *Codebase health* sidebar group. The "When to do this" paragraph should read "~93K lines of production Rust (119 files in src/, re-baked 2026-05-17) … 88% growth". **http://localhost:4321/reference/roadmap/** UPDATED overview. The Infrastructure improvements section's "Docker API migration" bullet should now describe Phase 1 as the next concrete PR with the open-findings link, and end with "(status: partially scoped)". Signed-off-by: Alexey Zhokhov <alexey@zhokhov.com> Co-authored-by: Amp <amp@ampcode.com>
donbeave
added a commit
that referenced
this pull request
May 18, 2026
…hase 1 (#366) ## Summary Re-bakes the codebase-readability program's May 2026 baseline against today's tree (LOC, file counts, mega-function sizes, `//!` coverage, duplication counts) and adds a trend caution showing every metric except `"Dockerfile"` literals regressed since the original audit — making the gap between "audit happened" and "extraction work scheduled" visible to anyone landing on the page. Cargo workspace split's LOC reference is updated to match. Separately, resolves the standing contradiction between the deferred Bollard migration and two still-Medium open review findings (#13 cleanup string-matching, #14 inspect-collapse-to-not-found) by carving out a concrete Phase 1 scope (lifecycle, cleanup, inspect via Bollard) with named files, out-of-scope items, and acceptance criteria; the open findings catalog now back-links both items to that Phase 1 so the two pages agree on ownership. ## What's deferred (follow-up PRs) - `jackin-daemon` phase-order section so the four reactive-daemon leaves (daemon, live-auth-sync, attention-prompts, host-bridge, desktop hub) have one canonical sequencing reference. - `reproducibility-pinning` operator-review pass (the page has been "agent brainstorm, not yet reviewed" for a long time). - `multi-runtime-support` "Remaining Work" bullets — split into acceptance-criteria-bearing leaves or annotate each bullet with a definition of done. - Bollard Phase 2 (`docker build`, interactive `docker run -it` via Bollard) — kept deferred per the original "incremental is pragmatic" rationale. ## Verify locally ### Checkout Paste this first to bypass the `tirith` paste scanner for the rest of the session: ```sh export TIRITH=0 ``` Then paste the checkout block: ```sh mkdir -p "$HOME/Projects/jackin-project/test" cd "$HOME/Projects/jackin-project/test" if [ ! -d jackin/.git ]; then git clone https://github.com/jackin-project/jackin.git fi cd jackin mise trust git fetch -f origin docs/roadmap-rebake-audit-and-bollard-phase1:refs/remotes/origin/docs/roadmap-rebake-audit-and-bollard-phase1 git checkout -B docs/roadmap-rebake-audit-and-bollard-phase1 refs/remotes/origin/docs/roadmap-rebake-audit-and-bollard-phase1 ``` ### Documentation ```sh cd docs bun install --frozen-lockfile bunx astro sync bunx tsc --noEmit bun run build bun run check:repo-links bun run dev ``` Astro serves at `http://localhost:4321/`. Pages to walk: **http://localhost:4321/reference/roadmap/codebase-readability/** UPDATED roadmap page in the *Internals → Roadmap → Codebase health* sidebar group. New "Trend since the original May 2026 audit" caution Aside at the top should render under the five numbered goals, and the per-module health table plus Tier A/B/C tables should show the refreshed LOC numbers (largest file 7593L, `fn run` 1186L). The "Current metrics" table near the bottom now has three columns (today / original May 2026 audit / pre-audit) instead of two. **http://localhost:4321/reference/roadmap/bollard-migration/** UPDATED roadmap page in the *Internals → Roadmap → Infrastructure* sidebar group. Status now reads "Partially scoped"; new "Open Review Findings This Resolves" and "Phased Plan" sections should render with the in-scope files, out-of-scope deferrals, and acceptance criteria for Phase 1. **http://localhost:4321/reference/roadmap/open-review-findings/** UPDATED roadmap page in the same Infrastructure sidebar group. Findings #13 and #14 should each end with "Scoped for the Bollard migration Phase 1." and the link should resolve. **http://localhost:4321/reference/roadmap/cargo-workspace-split/** UPDATED roadmap page in the *Codebase health* sidebar group. The "When to do this" paragraph should read "~93K lines of production Rust (119 files in src/, re-baked 2026-05-17) … 88% growth". **http://localhost:4321/reference/roadmap/** UPDATED overview. The Infrastructure improvements section's "Docker API migration" bullet should now describe Phase 1 as the next concrete PR with the open-findings link, and end with "(status: partially scoped)". Signed-off-by: Alexey Zhokhov <alexey@zhokhov.com> Co-authored-by: Amp <amp@ampcode.com>
donbeave
added a commit
that referenced
this pull request
May 20, 2026
…se-readability.mdx (#418) PR #337 rewrote Phase 2 of codebase-readability.mdx from a single linked-name table into Tier A/B/C LOC tables and dropped the leaf links to the four existing split-* roadmap pages (split-runtime-launch, split-input-editor, split-operator-env, split-app-mod). Those pages stayed in the sidebar but became unreachable from the parent program doc and the roadmap overview. Three subsequent re-bakes (#355, #366, #387) did not restore the links. Adds a short "Design pages" subsection at the top of Phase 2 linking the four split-* pages with their LOC and one-line scope, and notes that the remaining Tier A/B/C entries do not yet have dedicated pages. Sidebar and overview audits pass after the change; Tier A/B/C tables are unchanged. Signed-off-by: Alexey Zhokhov <alexey@zhokhov.com> Co-authored-by: Amp <amp@ampcode.com>
donbeave
added a commit
that referenced
this pull request
Jun 7, 2026
…se-readability.mdx (#418) PR #337 rewrote Phase 2 of codebase-readability.mdx from a single linked-name table into Tier A/B/C LOC tables and dropped the leaf links to the four existing split-* roadmap pages (split-runtime-launch, split-input-editor, split-operator-env, split-app-mod). Those pages stayed in the sidebar but became unreachable from the parent program doc and the roadmap overview. Three subsequent re-bakes (#355, #366, #387) did not restore the links. Adds a short "Design pages" subsection at the top of Phase 2 linking the four split-* pages with their LOC and one-line scope, and notes that the remaining Tier A/B/C entries do not yet have dedicated pages. Sidebar and overview audits pass after the change; Tier A/B/C tables are unchanged. Signed-off-by: Alexey Zhokhov <alexey@zhokhov.com> Co-authored-by: Amp <amp@ampcode.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Re-bakes the codebase-readability program's May 2026 baseline against today's tree (LOC, file counts, mega-function sizes,
//!coverage, duplication counts) and adds a trend caution showing every metric except"Dockerfile"literals regressed since the original audit — making the gap between "audit happened" and "extraction work scheduled" visible to anyone landing on the page. Cargo workspace split's LOC reference is updated to match. Separately, resolves the standing contradiction between the deferred Bollard migration and two still-Medium open review findings (#13 cleanup string-matching, #14 inspect-collapse-to-not-found) by carving out a concrete Phase 1 scope (lifecycle, cleanup, inspect via Bollard) with named files, out-of-scope items, and acceptance criteria; the open findings catalog now back-links both items to that Phase 1 so the two pages agree on ownership.What's deferred (follow-up PRs)
jackin-daemonphase-order section so the four reactive-daemon leaves (daemon, live-auth-sync, attention-prompts, host-bridge, desktop hub) have one canonical sequencing reference.reproducibility-pinningoperator-review pass (the page has been "agent brainstorm, not yet reviewed" for a long time).multi-runtime-support"Remaining Work" bullets — split into acceptance-criteria-bearing leaves or annotate each bullet with a definition of done.docker build, interactivedocker run -itvia Bollard) — kept deferred per the original "incremental is pragmatic" rationale.Verify locally
Checkout
Paste this first to bypass the
tirithpaste scanner for the rest of the session:export TIRITH=0Then paste the checkout block:
Documentation
cd docs bun install --frozen-lockfile bunx astro sync bunx tsc --noEmit bun run build bun run check:repo-links bun run devAstro serves at
http://localhost:4321/. Pages to walk:http://localhost:4321/reference/roadmap/codebase-readability/
UPDATED roadmap page in the Internals → Roadmap → Codebase health sidebar group. New "Trend since the original May 2026 audit" caution Aside at the top should render under the five numbered goals, and the per-module health table plus Tier A/B/C tables should show the refreshed LOC numbers (largest file 7593L,
fn run1186L). The "Current metrics" table near the bottom now has three columns (today / original May 2026 audit / pre-audit) instead of two.http://localhost:4321/reference/roadmap/bollard-migration/
UPDATED roadmap page in the Internals → Roadmap → Infrastructure sidebar group. Status now reads "Partially scoped"; new "Open Review Findings This Resolves" and "Phased Plan" sections should render with the in-scope files, out-of-scope deferrals, and acceptance criteria for Phase 1.
http://localhost:4321/reference/roadmap/open-review-findings/
UPDATED roadmap page in the same Infrastructure sidebar group. Findings #13 and #14 should each end with "Scoped for the Bollard migration Phase 1." and the link should resolve.
http://localhost:4321/reference/roadmap/cargo-workspace-split/
UPDATED roadmap page in the Codebase health sidebar group. The "When to do this" paragraph should read "~93K lines of production Rust (119 files in src/, re-baked 2026-05-17) … 88% growth".
http://localhost:4321/reference/roadmap/
UPDATED overview. The Infrastructure improvements section's "Docker API migration" bullet should now describe Phase 1 as the next concrete PR with the open-findings link, and end with "(status: partially scoped)".