Skip to content

docs: re-bake roadmap metrics and fix stale claims across the site#387

Merged
donbeave merged 2 commits into
mainfrom
docs/roadmap-rebake-2026-05-18
May 18, 2026
Merged

docs: re-bake roadmap metrics and fix stale claims across the site#387
donbeave merged 2 commits into
mainfrom
docs/roadmap-rebake-2026-05-18

Conversation

@donbeave

@donbeave donbeave commented May 18, 2026

Copy link
Copy Markdown
Member

Summary

Sweep through the published docs site fixing stale claims across roadmap, operator-facing pages, role-authoring pages, and contributor-facing internals pages. Every change was cross-checked against the live source tree. No code or schema changes.

The PR has two layers:

  1. Roadmap re-bake (2026-05-18) of the Codebase Readability program, one day after the previous 2026-05-17 bake. Production Rust grew from ~93K → ~97K LOC, files > 1000 lines from 25 → 28, and runtime/launch.rs from 7593L → 7966L. Tier B in the Phase 2 split plan gains seven entries that crossed the 1000L line in the last day; Tier C shrinks from 10 to 5. The three Phase 2 split proposals (split-app-mod, split-input-editor, split-runtime-launch) get their file-size numbers refreshed.

  2. Site-wide stale-claim sweep across the operator, role-author, and internals surfaces. Highlights:

    • Hard rule violation removed. reference/goals/jackin-desktop-agent-hub.mdx referenced "PR 283" three times (banned by docs/AGENTS.md "Never reference open pull requests in published documentation") and pointed at a non-existent src/daemon.rs. Both replaced with state-only framing.
    • Agent-runtime list drift. The code supports claude, codex, amp, kimi, opencode, but several pages still listed a subset. Fixed across architecture.mdx, getting-started/why.mdx, guides/comparison.mdx, guides/security-model.mdx, guides/role-repos.mdx, guides/authentication/github-cli.mdx. The OpenCode link in why.mdx now points at the canonical anomalyco/opencode fork (was the dead opencode-ai/opencode link).
    • Primary/secondary session vocabulary retired. container-session-lifecycle.mdx had already retired the distinction ("All agent sessions are equal — there is no 'primary' or 'secondary' distinction") but architecture.mdx and runtime-instance-model.mdx still used it. Reconciled.
    • Schema-version stamps. Example manifests in developing/creating-roles.mdx and guides/role-repos.mdx still used version = "v1alpha3"; one was internally inconsistent because it declared a [kimi] block that schema-versions explicitly requires v1alpha4 for. All four bumped.
    • CLI command-page corrections. Cross-checked against src/cli/*.rs:
      • commands/load.mdx: SELECTOR fallback says "last-used or default role", not "agent".
      • commands/role.mdx: add construct-version and published-image subcommands that exist in clap but weren't documented.
      • commands/purge.mdx and commands/eject.mdx: --all description reframed away from the non-existent "default instance" concept.
      • commands/workspace.mdx: add the --prune and --yes/-y flags to the workspace edit options table.
    • TUI design decisions. mount_isolation_choice.rs was listed in the flat button-strip exception list but does not exist in src/console/widgets/.
    • Installation page. jackin --version example output was the aspirational jackin 1.0.0; replaced with the actual jackin 0.6.0-dev from Cargo.toml.
    • Environment variables guide. Reserved-name list was missing JACKIN_GIT_COAUTHOR_TRAILER and JACKIN_GIT_DCO, both present in env_model.rs's RESERVED_RUNTIME_ENV_VARS.

Roadmap-overview reconciliation done in pass 1 (multi-runtime title, reproducibility-pinning status wording, selectable-sandbox-backends em dash) is unchanged.

What's deferred

Items surfaced during the audit but not fixed in this PR (each needs operator input or a code change rather than a docs edit):

  • bollard-migration still claims Phase 1 is "the next concrete PR" but no bollard dependency has landed. Status wording may want softening.
  • workspace-claude-token-setup lists a "canonical oauth_token auth slot" as remaining work. The current code uses an oauth_token symbol but as the bridge auth_forward = "oauth_token" mode, not a dedicated Claude config slot — left alone.
  • CLI clap help-text drift. jackin config auth set --agent help only advertises claude/codex/amp (missing kimi/opencode); jackin workspace create/edit --default-agent help is missing kimi. The docs already document the full agent list, so this is a code-side fix (src/cli/config.rs, src/cli/workspace.rs), not a docs fix.
  • Construct image default tag conflict. configuration.mdx documents JACKIN_CONSTRUCT_IMAGE default as projectjackin/construct:trixie; developing/construct-image.mdx and derived_image.rs consistently use projectjackin/construct:0.1-trixie. The CONSTRUCT_IMAGE constant in src/repo_contract.rs is projectjackin/construct:trixie. Left for the operator to disambiguate.

Verify locally

Checkout

Paste this first to bypass the tirith paste scanner for the rest of the session:

export TIRITH=0

Then paste the checkout block:

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-2026-05-18:refs/remotes/origin/docs/roadmap-rebake-2026-05-18
git checkout -B docs/roadmap-rebake-2026-05-18 refs/remotes/origin/docs/roadmap-rebake-2026-05-18

Run the docs site locally

cd docs
bun install --frozen-lockfile
bun run dev

Astro serves at http://localhost:4321/. Open each changed page directly:

Roadmap re-bake:

Site-wide sweep:

Static checks

cd docs
bun run build
bun run check:repo-links
bunx tsc --noEmit

All three pass on this branch locally.

Migration notes

None.

donbeave and others added 2 commits May 18, 2026 17:26
…dmap claims

Re-bakes the Codebase Readability program one day after the previous
2026-05-17 bake. Production Rust has grown from ~93K → ~97K LOC since
yesterday, files > 1000 lines from 25 → 28, and `runtime/launch.rs` from
7593L → 7966L. Updates per-module health, Tier A/B/C file lists, recommended
split order, mega-function line counts, constants-table occurrence counts,
and the metrics table to match the live tree. Tier B gains seven files that
crossed the 1000L line in the last day; Tier C shrinks from 10 to 5.

Refreshes the three Phase 2 split proposals (`split-app-mod`,
`split-input-editor`, `split-runtime-launch`) so each file-size claim
matches its file on disk.

Cleans up four small drifts in the roadmap overview:

- `multi-runtime-support` overview bullet renamed to match the leaf page,
  which already covers Codex, Amp, Kimi, and OpenCode rather than just
  Codex and Amp.
- `reproducibility-pinning` status wording in the overview reconciled
  with the leaf page ("open — agent brainstorm, not yet reviewed by the
  operator" wins).
- `selectable-sandbox-backends` status line: ASCII hyphen → em dash so it
  matches every other roadmap page.

No source code or schema changes.

Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: T-019e3c19-0f6a-73d8-9351-059d7a809860
Signed-off-by: Alexey Zhokhov <alexey@zhokhov.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019e3c19-0f6a-73d8-9351-059d7a809860
Co-authored-by: Amp <amp@ampcode.com>
…rfaces

Second pass over the docs site, following the roadmap re-bake. Each
finding cross-checked against the live source tree.

Hard rule violation removed:

- reference/goals/jackin-desktop-agent-hub.mdx: drop three references to
  "PR 283" (banned per docs/AGENTS.md "Never reference open pull
  requests in published documentation"); replace with state-only
  framing. Also remove the reference to a non-existent
  `src/daemon.rs`.

Agent-runtime list drift (code supports claude/codex/amp/kimi/opencode;
several pages still named a subset):

- reference/architecture.mdx: Amp added to the role/agent enumeration.
- getting-started/why.mdx: trusted-runtime list now lists all 5 agents
  and the OpenCode link points at the canonical `anomalyco/opencode`
  fork (was `opencode-ai/opencode`).
- guides/comparison.mdx: persistence row and runtime-installation note
  now cover all 5 agents.
- guides/security-model.mdx: "regardless of Claude Code permissions"
  generalized; "forwards Claude Code OAuth credentials" widened to
  cover all forwarded credential axes.
- guides/role-repos.mdx: Aside and trailing note generalized from
  "installing Claude Code" / "Claude installation" to all agent
  runtimes.
- guides/authentication/github-cli.mdx: parallel-flow reference
  widened from Claude/Codex to all five agents.

Primary/secondary session vocabulary retired
(per the canonical statement in container-session-lifecycle.mdx):

- reference/architecture.mdx: "Secondary sessions started via
  hardline --new" replaced with "Additional sessions".
- reference/runtime-instance-model.mdx: hardline table row, hardline
  --new prose, and console instance-surface bullet rephrased so they
  no longer use the retired primary/secondary distinction.

Schema-version stamps:

- developing/creating-roles.mdx: three example manifests bumped from
  `v1alpha3` to `v1alpha4` (the multi-agent example used `kimi`,
  which the schema-versions reference explicitly requires v1alpha4).
- guides/role-repos.mdx: the example manifest bumped to v1alpha4.

CLI / command-page corrections (cross-checked against src/cli/*.rs):

- commands/load.mdx: SELECTOR description said the omitted-selector
  fallback was the last-used "agent"; clap actually falls back to
  the last-used "role".
- commands/role.mdx: add `construct-version` and `published-image`
  subcommands that exist in clap (src/cli/role.rs) but were missing
  from the documented commands table.
- commands/purge.mdx and commands/eject.mdx: `--all` description
  reframed from the non-existent "default instance" concept to the
  actual semantics (errors-on-ambiguous-match without --all).
- commands/workspace.mdx: add the `--prune` and `--yes`/-y flags
  to the `workspace edit` options table; both are defined in clap
  but were only mentioned in trailing prose.

Other:

- reference/tui-design-decisions.mdx: drop `mount_isolation_choice.rs`
  from the flat button-strip widgets exception list; the file does not
  exist in src/console/widgets/.
- getting-started/installation.mdx: example `--version` output now
  matches Cargo.toml (0.6.0-dev), not the aspirational 1.0.0.
- guides/environment-variables.mdx: reserved-name list now includes
  `JACKIN_GIT_COAUTHOR_TRAILER` and `JACKIN_GIT_DCO`, which were
  added to env_model.rs's RESERVED_RUNTIME_ENV_VARS without a docs
  update.

No source code or schema changes.

Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: T-019e3c19-0f6a-73d8-9351-059d7a809860
Signed-off-by: Alexey Zhokhov <alexey@zhokhov.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019e3c19-0f6a-73d8-9351-059d7a809860
Co-authored-by: Amp <amp@ampcode.com>
@donbeave donbeave changed the title docs(roadmap): re-bake codebase-readability metrics and fix stale roadmap claims docs: re-bake roadmap metrics and fix stale claims across the site May 18, 2026
@donbeave donbeave merged commit d844141 into main May 18, 2026
18 checks passed
@donbeave donbeave deleted the docs/roadmap-rebake-2026-05-18 branch May 18, 2026 17:42
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
)

Sweep through the published docs site fixing stale claims across roadmap, operator-facing pages, role-authoring pages, and contributor-facing internals pages. Every change cross-checked against the live source tree. No code or schema changes.

Two layers:

1. Codebase Readability roadmap re-bake (2026-05-18) — production Rust ~93K → ~97K LOC, files > 1000 lines 25 → 28, runtime/launch.rs 7593L → 7966L. Tier B gains seven entries that crossed the 1000L line; Tier C shrinks 10 → 5. The three Phase 2 split proposals (split-app-mod, split-input-editor, split-runtime-launch) get their file-size numbers refreshed.

2. Site-wide stale-claim sweep:
   - Hard rule violation removed: reference/goals/jackin-desktop-agent-hub.mdx referenced "PR 283" three times (banned by docs/AGENTS.md) and a non-existent src/daemon.rs. Both replaced with state-only framing.
   - Agent-runtime list drift: code supports claude/codex/amp/kimi/opencode but several pages still named a subset. Fixed across architecture.mdx, getting-started/why.mdx, guides/comparison.mdx, guides/security-model.mdx, guides/role-repos.mdx, guides/authentication/github-cli.mdx. OpenCode URL now points at the canonical anomalyco/opencode fork.
   - Primary/secondary session vocabulary retired across architecture.mdx and runtime-instance-model.mdx (container-session-lifecycle.mdx had already retired it).
   - Schema-version stamps: example manifests in developing/creating-roles.mdx and guides/role-repos.mdx bumped from v1alpha3 to v1alpha4 (one example was internally inconsistent because it used [kimi], which requires v1alpha4).
   - CLI command-page corrections: commands/load.mdx SELECTOR fallback noun (role, not agent); commands/role.mdx adds construct-version and published-image subcommands; commands/purge.mdx and commands/eject.mdx --all semantics; commands/workspace.mdx adds --prune and --yes flags.
   - reference/tui-design-decisions.mdx: drop mount_isolation_choice.rs (file does not exist).
   - getting-started/installation.mdx: jackin --version example output now matches Cargo.toml (0.6.0-dev) instead of the aspirational 1.0.0.
   - guides/environment-variables.mdx: reserved-name list now includes JACKIN_GIT_COAUTHOR_TRAILER and JACKIN_GIT_DCO.

Roadmap-overview reconciliation also done: multi-runtime title widened to include Kimi and OpenCode, reproducibility-pinning status wording reconciled, selectable-sandbox-backends em dash typo fixed.

Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: T-019e3c19-0f6a-73d8-9351-059d7a809860
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant