Skip to content

docs(dub-84): refresh docs + website for post-March feature surface#110

Merged
dubscode merged 3 commits into
mainfrom
feature/dub-84-refresh-docs-and-website-for-post-march-dubstack-feature
May 25, 2026
Merged

docs(dub-84): refresh docs + website for post-March feature surface#110
dubscode merged 3 commits into
mainfrom
feature/dub-84-refresh-docs-and-website-for-post-march-dubstack-feature

Conversation

@dubscode

Copy link
Copy Markdown
Contributor

TL;DR

Docs-only refresh aligning README, QUICKSTART, docs intro, command references, guides, and skills with the post-March CLI surface. Added 14 missing command pages, fixed the stale dubstack.back MCP note, replaced single-level-undo wording with the multi-level undo/redo + 20-entry ring buffer reality, refreshed the homepage with tree-shaped stacks, Agents & MCP, Shell & IDE Integration, AI-across-the-flow messaging.

Why

Docs lagged a large post-March feature burst (DUB-67/69/70 + tree-shaped stacks, MCP, multi-trunk, SQLite, multi-level undo).

24 public commands had no dedicated docs page; navigation didn't reflect shipped surfaces.

User-facing copy claimed behavior that has shipped is 'coming later' (mcp.mdx) or undersold what shipped (undo).

Before

  • Homepage led with Graphite-compatibility basics; no mention of MCP, AI providers, shell integration, or retarget action.
  • README and QUICKSTART omitted MCP, JSON output, theming, SQLite, and accurate undo.
  • mcp.mdx said dubstack.back 'will be added later' — it has shipped.
  • Seven docs + skills files claimed undo was single-level for create/restack only.

After

  • Homepage reorganized around 6 capability cards: tree-shaped stacks, safe restack & merge, AI across the flow, agents & MCP, shell & IDE integration, Graphite-compatible.
  • 14 new command pages cover ai, config, mcp, init, install, flow, pr, history, status, watch, migrate, trunk, freeze, prune; commands/meta.json updated for nav.
  • MCP guide lists dubstack.back correctly; stale 'will be added later' sentence removed.
  • All single-level undo wording replaced with multi-level undo/redo + 20-entry ring buffer across docs, README, QUICKSTART, and shipped/agent skills.

File-by-file

apps/docs/src/app/(home)/page.tsx

mod +32 / -14

Homepage refresh: hero copy mentions tree-shaped stacks + agents; features grid expanded from 4 to 6 cards (Tree-Shaped Stacks, Safe Restack & Merge, AI Across The Flow, Agents & MCP, Shell & IDE Integration, Graphite-Compatible). Layout responsive to three columns at lg.

apps/docs/content/docs/commands/ai.mdx

new +110 / -0

New dub ai page consolidating subcommands setup, ask, env, resolve. Provider list (Gemini, Vercel AI Gateway, Amazon Bedrock, Anthropic, OpenAI, Ollama) with env-var table. Adjudication and --dry-run coverage.

apps/docs/content/docs/commands/config.mdx

new +145 / -0

New dub config page covering 11 shipped subcommands: ai-assistant, ai-provider, ai-model, ai-defaults, ai-prompts, ai-prompts-auto-accept, submit-default, reviewers, mcp-mode, storage-backend, theme.

apps/docs/content/docs/commands/mcp.mdx

new +34 / -0

New short command page for dub mcp pointing to the guide; includes mcp-mode security model.

apps/docs/content/docs/commands/freeze.mdx

new +49 / -0

New combined dub freeze / dub unfreeze page with --downstack/--upstack/--dry-run/--json. Notes restack/sync/post-merge skip and doctor surfacing.

apps/docs/content/docs/commands/trunk.mdx

new +56 / -0

New dub trunk grouped page covering list/add/remove/set-default subcommands for multi-trunk repos.

apps/docs/content/docs/commands/init.mdx

new +28 / -0

New dub init page documenting --restore-from-refs.

apps/docs/content/docs/commands/install.mdx

new +44 / -0

New dub install page covering the retarget-action recipe with --dry-run/--force.

apps/docs/content/docs/commands/migrate.mdx

new +36 / -0

New dub migrate storage --to <json|sqlite> page for storage backend migration.

apps/docs/content/docs/commands/status.mdx

new +41 / -0

New dub status page for shell/IDE prompt integration with --json/--live/--no-pr.

apps/docs/content/docs/commands/watch.mdx

new +38 / -0

New dub watch long-lived monitor page (--interval, --ui).

apps/docs/content/docs/commands/history.mdx

new +39 / -0

New dub history page (-n/--limit, --json) with MCP audit-history integration note.

apps/docs/content/docs/commands/flow.mdx

new +70 / -0

New dub flow (alias f) page covering AI-assisted authoring with --ai/--dry-run.

apps/docs/content/docs/commands/pr.mdx

new +30 / -0

New dub pr [branch|number] page (opens PR in browser via gh).

apps/docs/content/docs/commands/prune.mdx

new +47 / -0

New dub prune page (--apply/--all/--no-fetch) for removing stale tracked metadata.

apps/docs/content/docs/commands/meta.json

mod +14 / -0

Added all 14 new pages in a logical order so they appear in the docs sidebar.

apps/docs/content/docs/guides/mcp.mdx

mod +1 / -3

Added dubstack.back to the mutating tools table; removed stale 'Tier 3 command family is still landing... dubstack.back will be added later' note since mcp.ts now registers it.

apps/docs/content/docs/commands/log.mdx

mod +28 / -5

Added tree-shaped stacks section: current-path bold, dimmed siblings, frozen markers, 30s cached PR/CI annotations. New example output for tree-shaped stacks.

README.md

mod +88 / -3

Replaced single-paragraph undo section with multi-level undo/redo + 20-entry ring buffer. Updated Graphite map row for undo/redo. New sections for dub mcp, multi-trunk repositories, storage backend (SQLite), and terminal theming.

QUICKSTART.md

mod +35 / -5

Replaced section 11 single-level undo with multi-level undo/redo. Added Programmatic & Agent Use (JSON + MCP install) and Theming/Storage sections.

apps/docs/content/docs/index.mdx

mod +7 / -3

Expanded intro with bullet list highlighting AI providers, agents/MCP/JSON, safe merges + retargeting GitHub Action, multi-level undo/redo, shell/IDE integration. Fast Command List undo row updated.

apps/docs/content/docs/getting-started/quickstart.mdx

mod +1 / -1

Fast Command List: undo row updated to multi-level undo/redo.

apps/docs/content/docs/guides/conflict-resolution.mdx

mod +1 / -1

Recovery table: replaced single-level undo with multi-level undo pairing with redo.

apps/docs/content/docs/guides/stacking-workflow.mdx

mod +9 / -4

Recovery section: documents undo --steps, undo --list, redo, and full operation coverage. Links to commands/undo for the table.

apps/docs/content/docs/commands/create.mdx

mod +1 / -1

Undo note updated to multi-level + 20-entry ring buffer with redo.

apps/docs/content/docs/commands/reorder.mdx

mod +1 / -1

Related section: replaced 'roll back the last create/restack/move/rename/reorder' with multi-level undo/redo description.

skills/dubstack/SKILL.md

mod +1 / -1

Skill recovery row updated to multi-level undo/redo.

skills/dubstack/references/commands.md

mod +5 / -1

Recovery table expanded with --steps, --list, redo, continue/abort entries.

skills/dubstack/references/workflows.md

mod +8 / -2

Workflows: replaced single-level undo description with multi-level undo/redo + operation list.

.agents/skills/dubstack/SKILL.md

mod +1 / -1

Agent skill row updated to multi-level undo/redo.

.agents/skills/dubstack/references/commands.md

mod +5 / -1

Agent reference recovery table updated to match shipped skill.

.agents/skills/dubstack/references/workflows.md

mod +8 / -2

Agent workflow reference recovery updated to multi-level undo/redo.

Where to focus review

  1. Source vs. docs flag accuracy - apps/docs/content/docs/commands/{ai,config,freeze,install,migrate,prune,status,trunk,watch}.mdx: Every flag and value documented on the new command pages was cross-checked against packages/cli/src/index.ts and packages/cli/src/commands/*.ts. Confirm no invented flags slipped through.
  2. Multi-level undo wording is consistent everywhere - README.md, QUICKSTART.md, apps/docs/content/docs/**, skills/**, .agents/skills/**: Old 'single-level undo for create/restack' wording would mislead users about the shipped 20-entry ring buffer + dub redo. Grepped for 'single-level', 'one level', 'undo last create/restack' — should be zero remaining.
  3. MCP guide reflects dubstack.back shipping - apps/docs/content/docs/guides/mcp.mdx: dubstack.back is now in the mutating tools table; the 'will be added later' sentence is removed. Verifies the issue's named stale item.
  4. Homepage TSX validity and feature coverage - apps/docs/src/app/(home)/page.tsx: Six feature cards must cover the surfaces called out in the issue (tree-shaped stacks, agents/MCP, AI workflows, shell integration). All lucide icon imports must be used; biome auto-formatted the file clean.

Test plan

  • build: Docs site builds with new pages - pnpm --filter docs build succeeded; all new command pages prerendered statically alongside existing ones.
  • unit: Docs unit tests - pnpm --filter docs test — 2/2 tests passed (page tree + clean restart script).
  • manual: Browser walkthrough of homepage and new pages - .reports/dub-84-docs-walkthrough.gif (7 frames, 1353x908) covers homepage hero/feature grid + /docs/commands/{ai,config,mcp,undo} + /docs/guides/mcp.

Quality gates

  • Lint + format: pnpm checks - passed (biome check clean after one auto-fix on homepage formatting.)
  • Typecheck: pnpm typecheck - passed (turbo: 3/3 packages green (docs, dubstack, dubstack-retarget-action).)
  • Unit tests: pnpm test - passed (turbo: 6/6 tasks green; all CLI and docs tests passed.)
  • Docs build: pnpm --filter docs build - passed (Next.js build succeeded with all new command pages prerendered.)

Self-QA

Download QA recording

Browser walkthrough of the refreshed homepage (hero + 6 feature cards) and several new/modified docs pages.

  • Homepage hero with updated tree-shaped stacks copy renders.
  • Six-card features grid renders with new icons (Layers, RefreshCw, Sparkles, Bot, Terminal, Network) and accurate copy.
  • /docs/commands/ai loads with full subcommand structure, env-var table, provider list, and ToC.
  • /docs/commands/config loads with all 11 subcommands and ToC per subcommand.
  • /docs/commands/mcp loads as a short page linking out to /docs/guides/mcp.
  • /docs/commands/undo renders the multi-level undo + redo content with the recovery sidebar entry highlighted.
  • /docs/guides/mcp shows dubstack.back in the mutating tools table without any stale 'coming later' note.

Acceptance criteria

  • Docs inventory maps all public CLI commands/options from packages/cli/src/index.ts to docs coverage. - Coverage map built by Explore subagent; 14 new command pages added for previously missing surfaces (ai, config, mcp, init, install, flow, pr, history, status, watch, migrate, trunk, freeze, prune). Lower-traffic commands (abort, continue, parent, children, branch info, untrack) remain documented within grouped pages and README command reference.
  • Homepage, README, quickstarts, command refs, guides, and skills are consistent with shipped behavior. - Homepage updated with 6 feature cards covering tree-shaped stacks, Agents & MCP, Shell & IDE integration, AI across the flow. README, QUICKSTART, docs intro, and skills all updated for MCP, JSON output, theming, SQLite, and multi-level undo/redo.
  • DUB-67, DUB-69, and DUB-70 are represented accurately according to merge state (all Done). - All three are merged (verified via linear issues get). Shell completion + man pages documented in shell-integration.mdx + README; theming + migration guides + dry-run on every mutating command documented in config.mdx, freeze.mdx, install.mdx and the README theming section. Existing migration guides already cover Graphite/Charcoal/ghstack/Sapling/spr.
  • No unmerged DUB-69 or DUB-70 behavior is presented as generally available. - Both are merged; no upcoming/coming-soon language used.
  • Known stale mcp.mdx and shell-integration.mdx issues fixed when their source behavior is merged. - mcp.mdx: stale dubstack.back note removed and tool added to mutating table. shell-integration.mdx already covered DUB-67 completion + man content (verified by Explore subagent).
  • Docs navigation metadata includes new pages. - apps/docs/content/docs/commands/meta.json updated with all 14 new pages in a logical order.
  • Verification gates pass. - pnpm checks, pnpm typecheck, pnpm test, pnpm --filter docs test, pnpm --filter docs build all green.

Adversarial review

Iterations: 1

Remaining critical/major: 0/0

Remaining minor/nitpick: 0/0

  • feature-dev:code-reviewer cross-checked every documented flag on the 14 new pages against packages/cli/src/index.ts and packages/cli/src/commands/*.ts. Confirmed: config subcommands and values, ai resolve flags, ai env env-var names, freeze/unfreeze flags, install recipe + flags, status flags, watch flags + default interval, migrate --to option, trunk subcommands, prune flags, history flags. Verified no remaining single-level undo wording, dubstack.back fix complete, homepage TSX has no dead lucide imports, meta.json filenames match real files. No critical or major findings.

Dependencies

Rollout

Docs-only change. Merges to main update the docs site at next deploy. No flag, no migration, no runtime impact.

  • On merge - Docs site deploy: apps/docs is auto-deployed from main; the 14 new pages and refreshed homepage go live with the next docs deploy.
  • Post-merge - No follow-up required: No data migrations, feature flags, or runtime side effects.
  • Optional - Future docs work: Standalone pages for low-traffic commands (abort, continue, parent, children, branch info, untrack) could land in a follow-up if desired; they remain documented within grouped pages today.

Commit

docs(dub-84): refresh docs + website for post-March feature surface

Coverage refresh after the May 23-25 feature burst (DUB-67/69/70 + tree-shaped
stacks, MCP, AI providers, JSON output, multi-trunk, SQLite backend).

- 14 new command pages: ai, config, mcp, init, install, flow, pr, history,
  status, watch, migrate, trunk, freeze, prune.
- Fix stale mcp.mdx note about `dubstack.back` (shipped) and update guide
  table.
- Replace single-level undo wording with multi-level undo/redo + 20-entry
  ring buffer across README, QUICKSTART, docs, skills, references.
- Update homepage with tree-shaped stacks, Agents & MCP, Shell & IDE
  Integration, AI-across-the-flow messaging (6-card feature grid).
- Refresh README + QUICKSTART for MCP, multi-trunk, SQLite, theming, JSON.
- Tree-aware log.mdx with current-path highlighting and frozen markers.

Completes DUB-84
@vercel

vercel Bot commented May 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
dubstack Ready Ready Preview, Comment May 25, 2026 10:35pm

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Docs-only refresh aligning the docs site, README/QUICKSTART, and agent skills with the current post‑March DubStack CLI surface (tree-shaped stacks, MCP, multi-trunk, SQLite, and multi-level undo/redo).

Changes:

  • Refreshed the docs homepage and intro messaging to highlight tree-shaped stacks, agents/MCP, shell/IDE integration, and AI across the workflow.
  • Added 14 missing command reference pages and updated commands navigation metadata.
  • Updated undo documentation everywhere from “single-level” to multi-level undo/redo backed by a 20-entry ring buffer, and fixed the stale MCP guide note about dubstack.back.

Reviewed changes

Copilot reviewed 32 out of 32 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
apps/docs/src/app/(home)/page.tsx Refreshes the marketing homepage hero + feature grid to match current capabilities.
apps/docs/content/docs/commands/ai.mdx New command page documenting dub ai subcommands, providers, env vars, and resolve flow.
apps/docs/content/docs/commands/config.mdx New command page documenting repo-local configuration subcommands (AI, MCP mode, storage, theme, etc.).
apps/docs/content/docs/commands/mcp.mdx New command page for dub mcp with security-mode overview and guide link.
apps/docs/content/docs/commands/freeze.mdx New command page for dub freeze/dub unfreeze, scope flags, and dry-run behavior.
apps/docs/content/docs/commands/trunk.mdx New command page covering multi-trunk inspection and trunk management subcommands.
apps/docs/content/docs/commands/init.mdx New command page for dub init including --restore-from-refs.
apps/docs/content/docs/commands/install.mdx New command page documenting recipe installs (retarget action) and overwrite/dry-run behavior.
apps/docs/content/docs/commands/migrate.mdx New command page documenting storage migration between JSON and SQLite.
apps/docs/content/docs/commands/status.mdx New command page for prompt/IDE-oriented dub status with cached vs live behavior.
apps/docs/content/docs/commands/watch.mdx New command page for long-lived monitoring via dub watch and interval/UI flags.
apps/docs/content/docs/commands/history.mdx New command page documenting dub history and JSON output.
apps/docs/content/docs/commands/flow.mdx New command page documenting the AI-assisted end-to-end dub flow (alias dub f).
apps/docs/content/docs/commands/pr.mdx New command page for opening PRs by branch or number via gh.
apps/docs/content/docs/commands/prune.mdx New command page documenting pruning stale tracked metadata.
apps/docs/content/docs/commands/meta.json Adds the new command pages to the docs sidebar/navigation ordering.
apps/docs/content/docs/guides/mcp.mdx Updates MCP guide to include dubstack.back and removes stale “coming later” language.
apps/docs/content/docs/commands/log.mdx Updates dub log docs to explain tree-shaped stacks and cached PR/CI annotations.
README.md Updates README command reference + adds MCP/multi-trunk/storage/theming sections and correct undo/redo description.
QUICKSTART.md Updates quickstart workflow docs for multi-level undo/redo + adds agent/MCP + theming/storage sections.
apps/docs/content/docs/index.mdx Refreshes docs introduction to reflect current capabilities and updates fast command list entries.
apps/docs/content/docs/getting-started/quickstart.mdx Updates fast command list undo entry to include redo + multi-level behavior.
apps/docs/content/docs/guides/conflict-resolution.mdx Updates troubleshooting table undo wording to multi-level undo/redo.
apps/docs/content/docs/guides/stacking-workflow.mdx Updates recovery guidance to document undo/redo flags and capabilities.
apps/docs/content/docs/commands/create.mdx Updates create docs to describe multi-level undo/redo behavior.
apps/docs/content/docs/commands/reorder.mdx Updates reorder docs to reference multi-level undo/redo wording.
skills/dubstack/SKILL.md Updates skill “fast command map” undo wording to include redo and ring buffer.
skills/dubstack/references/commands.md Updates skill command reference to document undo/redo flags (--steps, --list, etc.).
skills/dubstack/references/workflows.md Updates skill workflows recovery section to document undo/redo and ring details.
.agents/skills/dubstack/SKILL.md Updates agent skill fast map undo wording to include redo and ring buffer.
.agents/skills/dubstack/references/commands.md Updates agent command reference to include undo/redo flags and semantics.
.agents/skills/dubstack/references/workflows.md Updates agent workflow recovery guidance to multi-level undo/redo.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread apps/docs/content/docs/guides/conflict-resolution.mdx
- sqlite-backend.mdx: fix inspect example to drop the value (read form is `dub
  config storage-backend` without an argument).
- state-management.mdx, conflict-resolution.mdx, README.md: rename `undo.json`
  to `undo-log.json` (the actual file name; source: lib/undo-log.ts:89).
- unlink.mdx, move.mdx: add `text` language tag to ASCII tree code fences.
- history.mdx: use `--limit 50` long form in primary example to match
  README and the flag table.
- .claude/agents/code-reviewer.md, .agents/patterns/command-changes.md:
  refresh stale "undo is single-level" rule to describe the shipped
  multi-level ring buffer + redo contract.

Refs DUB-84
Copilot review on PR #110 flagged that README and conflict-resolution still
listed the legacy `undo.json`. The earlier review-fix commit renamed it to
`undo-log.json`; this commit also adds the `redo-log.json` companion file
(see `packages/cli/src/lib/undo-log.ts:94`) so readers don't go looking for
the redo ring under a different name.

Refs DUB-84
@dubscode dubscode enabled auto-merge (squash) May 25, 2026 22:35
@dubscode dubscode merged commit f8d51e7 into main May 25, 2026
12 checks passed
@dubscode dubscode deleted the feature/dub-84-refresh-docs-and-website-for-post-march-dubstack-feature branch May 25, 2026 22:36
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.10.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants