Skip to content

docs: roadmap cleanup — README sync, dependency graph, When-to-use sections, verified pnpm-store×nub compat - #94

Merged
baxyz merged 12 commits into
mainfrom
docs/roadmap-cleanup-pass
Sep 9, 2026
Merged

baxyz merged 12 commits into
mainfrom
docs/roadmap-cleanup-pass

Conversation

@baxyz

@baxyz baxyz commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Synced the root README's "Features" narrative and "Available Features" table — 8 features (helpers4-common, copilot-dev, claude-dev, mistral-dev, cline-dev, nub, bitwarden-secrets-manager, org-workspace) were missing from the public-facing docs while already present in AGENTS.md/src/.
  • Added a Mermaid dependency graph built from the actual dependsOn edges, plus 4 ready-to-copy feature-block stacks (web dev, web dev + E2E, AI pairing, multi-repo org bootstrap).
  • Added a "When to use / alternatives" section to the 5 features that were missing one (angular-dev, auto-header, shell-history-per-project, bitwarden-secrets-manager, github-dev).
  • Tested nub's compatibility with pnpm-store directly in a real container (inode comparison + an offline reinstall with nub's own cache wiped) — confirmed nub install hardlinks package content from pnpm-store's shared store instead of duplicating it. Documented the verified finding in both READMEs.
  • Evaluated adding @devcontainers/cli as a new feature or folding it into essential-dev — found ghcr.io/devcontainers-extra/features/devcontainers-cli already does exactly this, so pointed to it from the root README instead of reimplementing it.
  • Confirmed the "stop hand-maintaining AGENTS.md's Ver column" concern is already resolved by an existing CI check (shellcheck job in pr-validation.yml).

Closes 6 items on the helpers4/1 roadmap project's devcontainer backlog.

Test plan

  • jq empty on every touched manifest
  • Real container test for the nub/pnpm-store compatibility claim
  • CI green on this PR

baxyz and others added 12 commits September 9, 2026 16:39
The "Features" narrative and "Available Features" table only listed 13 of
21 features. Added the 8 missing ones (helpers4-common, copilot-dev,
claude-dev, mistral-dev, cline-dev, nub, bitwarden-secrets-manager,
org-workspace) to both sections, matching the existing per-feature format.

Closes the "Sync README.md feature list with AGENTS.md / actual src/ tree"
roadmap item.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…EADME

The feature table was a raw list with no sense of what depends on what, or
which combinations are meant to be used together. Added a Mermaid graph
built from the actual dependsOn edges (helpers4-common as the implicit
base; essential-dev -> typescript-dev -> vite-plus/playwright-dev; node ->
nub/playwright-dev; github-dev -> org-workspace), plus 4 ready-to-copy
feature blocks: web dev, web dev + E2E, AI pairing, and a multi-repo org
bootstrap using org-workspace as the replacement for this org's own .dev
repo's hand-written mounts.

Closes the "Root README: add dependency diagram and ready-to-copy full
stacks" roadmap item.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Roadmap item flagged this feature as missing the "why/alternatives"
section that nub, playwright-dev, pnpm-store, essential-dev, and
typescript-dev already had.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Roadmap item flagged this feature as missing the "why/alternatives"
section that nub, playwright-dev, pnpm-store, essential-dev, and
typescript-dev already had.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ection

Roadmap item flagged this feature as missing the "why/alternatives"
section that nub, playwright-dev, pnpm-store, essential-dev, and
typescript-dev already had.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ection

Roadmap item flagged this feature as missing the "why/alternatives"
section that nub, playwright-dev, pnpm-store, essential-dev, and
typescript-dev already had.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Roadmap item flagged this feature as missing the "why/alternatives"
section that nub, playwright-dev, pnpm-store, essential-dev, and
typescript-dev already had.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
angular-dev, auto-header, shell-history-per-project,
bitwarden-secrets-manager, and github-dev were bumped for their new
"When to use / alternatives" sections.

Closes the "Add 'When to use / alternatives' section to feature READMEs
that lack one" roadmap item.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Tested directly in a real container: nub install doesn't shell out to the
pnpm binary, but it does read the same store-dir/storeDir config pnpm-store
writes and hardlinks package content from it (confirmed via matching
inodes, and an offline reinstall with nub's own cache wiped that still
succeeded from pnpm-store's persisted content). Documents the pairing as
supported now that it's actually been verified.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Reciprocal note to nub's README — see that commit for how this was tested.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…docs

Closes the "Test pnpm-store compatibility with nub" roadmap item — verified
directly in a real container rather than left undocumented.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Evaluated adding @devcontainers/cli to essential-dev or as a new dedicated
feature (per the roadmap item), but ghcr.io/devcontainers-extra/features/
devcontainers-cli already does exactly this — a thin wrapper around
`npm install -g @devcontainers/cli`. Per this repo's own add-devcontainer-
feature conventions, an existing feature that covers the whole need should
be depended on rather than reimplemented, and there's no real value a
helpers4-specific version would add here. Documented it in the Testing
section instead of building anything.

Closes the "devcontainer: exposer le CLI devcontainer via une feature"
roadmap item.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

✅ PR Validation Passed

All checks passed!


📋 Pipeline Status

Job Status
🧾 Conventional Commits passing
🔖 Version Bump passing
🧪 Feature Tests passing
🐚 ShellCheck passing

🤖 Generated by @helpers4 CI • 2026-09-09

@baxyz
baxyz merged commit 6b28d0c into main Sep 9, 2026
41 checks passed
@baxyz
baxyz deleted the docs/roadmap-cleanup-pass branch September 9, 2026 18:33
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