Skip to content

Make user-facing docs backend-agnostic (fix stale 'msb from Phase 2'; msb is default) #307

Description

@wz-gsa

Problem

The workspace now supports multiple sandbox backends via the acq wrapper — sbx (Docker Sandboxes), msb (microsandbox, the default), and future ppp — but user-facing docs across the repos still present sbx as THE sandbox / the default onboarding path. This misleads new users onto sbx even though acq defaults to msb, and won't age well as backends grow.

Playbook was fixed in agentic-coding-playbook PR (feat/backend-agnostic-references) — this issue tracks the sibling cleanup in quickstart and patterns. Scope is USER-FACING framing only; backend adapters, sbx-specific how-to (QUICKSTART_SBX.md), sbx-specific ADRs, verify scripts, and backends: [sbx, msb] lists are legitimately sbx and stay.

quickstart (small — docs/QUICKSTART.md is the real debt)

The Quick Start walkthrough's primary Step 1–3 still walk the sbx path while a "msb is the default" banner sits three lines above — directly contradictory.

  • docs/QUICKSTART.md:41-51 — primary walkthrough + "Step 1: Prerequisites (sbx)" + sbx install/login as the primary prerequisites → lead with msb (default); demote sbx to the alternate section.
  • docs/QUICKSTART.md:282 — "default timeout for sbx exec" → neutralize (acq exec / name both).
  • README.md:117 — multi-repo mounting linked only into the sbx-specific guide → point at a neutral section.
  • (README:113-115 borderline; leave.)
  • Leave: the 42 AGENTS.md hits (legit "sbx or msb" pairs + sbx-specific tooling notes), BACKEND_GUIDE intro (correctly names msb default), all acq.backends/*, test-acq, verify-backends, QUICKSTART_SBX.md, sbx ADRs.

patterns (small — one repeated stale blurb + one ecosystem doc)

  • P4–P8: the boilerplate `sbx` today; `msb` from Phase 2 repeated across 5 acq-kits/*/README.md (git-ssh-sign, agentic-coding-playbook, usai-provider, zscaler-ca-certificate, + acq-kits/README.md:8) — factually wrong now: msb ships and is the default. One find/replace → "(msb — the default — and sbx today; ppp later)".
  • integrations/isolation/acq-kits/kits.yaml:5 — "For Phase 2 the supported backends are sbx and msb" → "today: msb (default) and sbx; ppp later".
  • docs/repository-ecosystem.md:200-221 — frames cross-repo mounting as an sbx-only / "Docker's sbx CLI" capability → neutralize to acq (both backends).
  • Leave: frozen sbx-kits/ redirect shim, verify scripts, schema enum, per-kit parity tables (accurate current-state), CHANGELOG.

Acceptance

  • quickstart QUICKSTART.md primary walkthrough leads with the default backend (msb); sbx demoted to alternate; the sbx exec timeout + multi-repo pointers neutralized
  • patterns acq-kits READMEs + kits.yaml no longer say "msb from Phase 2" (msb is default/shipped); repository-ecosystem.md cross-repo mounting is backend-neutral
  • no legitimately-sbx content (adapters, sbx how-to, sbx ADRs, parity tables) altered
  • framing avoids hardcoding the backend set (future ppp slots in without churn)

Sibling of the playbook agnostic-references PR. AI-assisted (OpenCode); recon-verified (conservative GENERIC-SHOULD classification). Requires human review.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions