Skip to content

docs(roadmap): reconcile roadmap items with shipped code state#355

Merged
donbeave merged 2 commits into
mainfrom
docs/roadmap-audit-fixes
May 16, 2026
Merged

docs(roadmap): reconcile roadmap items with shipped code state#355
donbeave merged 2 commits into
mainfrom
docs/roadmap-audit-fixes

Conversation

@donbeave

@donbeave donbeave commented May 16, 2026

Copy link
Copy Markdown
Member

Summary

Audit of all roadmap items under docs/src/content/docs/reference/roadmap/ against the current code surfaced two classes of drift: stale status/content on active roadmap pages, and fully shipped items that still had standalone roadmap pages.

What changed:

  • Updated the roadmap overview Completed list for shipped-but-unlisted behavior (jackin eject, jackin prune, jackin config trust, per-workspace git_pull_on_entry, macOS keep-awake) and corrected the workspace subcommand wording.
  • Reconciled active roadmap items whose remaining-work text no longer matched the code: config versioning, GitHub CLI auth strategy, per-mount references from dependent items, and the codebase-readability program row for the project-structure refresh.
  • Finished the residual PROJECT_STRUCTURE.md work by adding build.rs and the missing workflow entries.
  • Retired fully shipped roadmap pages instead of keeping Resolved pages: env var interpolation, per-mount isolation, split workspace config files, and project-structure update.
  • Repointed inbound roadmap links to canonical docs: role manifest interpolation, Workspaces per-mount isolation, Configuration per-workspace files, Codebase Map, and PROJECT_STRUCTURE.md.
  • Removed the Resolved sidebar group and updated the roadmap overview text to say shipped work belongs in Completed plus canonical docs.

The audit also checked the remaining Open / Proposed / Deferred / Partially implemented roadmap items for stealth-shipped work. I did not find another item that was fully implemented and still eligible for retirement.

Hard-rule callout

Roadmap freshness and retirement rule applied. Fully resolved items were removed from the roadmap sidebar/pages, inbound links were audited and repointed, and canonical docs now carry the shipped behavior. No host-side behavior or schema changes.

What's deferred (follow-up PRs)

None for the completed-item retirement pass in this PR.

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-audit-fixes:refs/remotes/origin/docs/roadmap-audit-fixes
git checkout -B docs/roadmap-audit-fixes refs/remotes/origin/docs/roadmap-audit-fixes

Docs gates

cd docs
bun install --frozen-lockfile
bun run build
bun run check:repo-links
bunx tsc --noEmit
bun test
bun run dev

Astro serves at http://localhost:4321/. Walk the changed pages:

http://localhost:4321/reference/roadmap/
Check the Completed list now links shipped env interpolation, per-mount isolation, split workspace config files, and project-structure refresh to canonical docs rather than retired roadmap pages. Confirm there is no Resolved sidebar group.

http://localhost:4321/reference/roadmap/config-versioning-migration/
The role-manifest example TOML block should show version = "v1alpha3".

http://localhost:4321/reference/roadmap/github-cli-auth-strategy/
Remaining Work item 1 should reference the existing jackin config auth set subcommand and link to src/cli/config.rs.

http://localhost:4321/reference/roadmap/codebase-readability/
The PROJECT_STRUCTURE.md refresh row should be marked completed and link to PROJECT_STRUCTURE.md plus the Codebase Map.

http://localhost:4321/reference/roadmap/ephemeral-mount-modes/
Per-mount-isolation references should point to the Workspaces guide instead of the retired roadmap page.

http://localhost:4321/reference/architecture/
The isolation-state table should say worktree or clone, and the limitations list should preserve the V1 isolation-mode edit caveat.

PROJECT_STRUCTURE.md

The root-level file is not part of the rendered docs site — check it in the GitHub diff or cat PROJECT_STRUCTURE.md locally. The Root Files table should include build.rs, and the CI/CD workflows table should list all seven workflows.

Migration notes

None.

donbeave and others added 2 commits May 16, 2026 14:50
Re-audit of all 67 roadmap items against current code surfaced several
drift points that this commit corrects:

- roadmap.mdx Completed list: 'add' workspace subcommand never existed;
  it is 'create'. Add shipped-but-unlisted features (jackin eject, jackin
  prune family, jackin config trust CLI, per-workspace git_pull_on_entry,
  macOS keep-awake reconciler). Reword 'Homebrew installation' as
  'Homebrew distribution' to clarify the sibling-repo packaging.
- split-workspace-config-files.mdx (Resolved): drop the
  '(single-file load/write today)' parentheticals on Related Files and
  note that the Open Questions section reflects ship-time decisions.
- per-mount-isolation.mdx (Implemented in V1): replace the placeholder
  'New module (e.g. src/isolation.rs)' with the actual src/isolation/
  directory module files; relocate the purge running-agent guard to
  src/runtime/cleanup.rs where it actually lives; document the V1 known
  limitation that isolation-mode flips between loads do not fire drift
  detection.
- config-versioning-migration.mdx: bump the role-manifest example from
  v1alpha2 to the current v1alpha3.
- github-cli-auth-strategy.mdx: 'jackin config auth set' already exists
  for agents; narrow the remaining work to extending it with a github
  target rather than introducing a new command.
- project-structure-update.mdx: status updated to 'Partially
  implemented'; most of the original drift is gone now that
  PROJECT_STRUCTURE.md was rewritten as a pointer file with the detailed
  module map delegated to the Codebase Map page. The remaining residual
  gaps (build.rs, ci.yml, preview.yml, renovate.yml,
  renovate-validate.yml) are closed in this commit by editing
  PROJECT_STRUCTURE.md directly.
- PROJECT_STRUCTURE.md: add build.rs and the four missing workflows to
  the Root Files and CI/CD tables.

Co-authored-by: Amp <amp@ampcode.com>
Signed-off-by: Alexey Zhokhov <alexey@zhokhov.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019e3108-da6f-774e-974a-56fdfb8ed7c9
Co-authored-by: Codex <codex@openai.com>
Signed-off-by: Alexey Zhokhov <alexey@zhokhov.com>
@donbeave donbeave force-pushed the docs/roadmap-audit-fixes branch from db91d48 to 221d023 Compare May 16, 2026 14:50
@donbeave donbeave merged commit 9ff5cc4 into main May 16, 2026
18 checks passed
@donbeave donbeave deleted the docs/roadmap-audit-fixes branch May 16, 2026 14:52
donbeave added a commit that referenced this pull request May 18, 2026
Audit the roadmap against the shipped code state and remove stale completed-roadmap pages.

The docs now retire env var interpolation, per-mount isolation, split workspace config files, and the project-structure refresh from `reference/roadmap/`, repointing their inbound links to canonical role-manifest, workspace, configuration, architecture, codebase-map, and PROJECT_STRUCTURE surfaces. Active roadmap items were reconciled where their remaining-work text no longer matched the code, and the roadmap overview now treats shipped work as Completed bullets instead of resolved pages.

Signed-off-by: Alexey Zhokhov <alexey@zhokhov.com>
Co-authored-by: Amp <amp@ampcode.com>
Co-authored-by: Codex <codex@openai.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019e3108-da6f-774e-974a-56fdfb8ed7c9
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>
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