Skip to content

sc-004.md

Latest commit

 

History

History
34 lines (28 loc) · 2.75 KB

sc-004.md

File metadata and controls

34 lines (28 loc) · 2.75 KB

← Back to Backlog

[SC-004] ✅ DONE - Consolidate documentation and make all docs reachable from README

Status: Done (2026-03-03) Priority: Medium Component: README.md, docs/

Summary: As a user or contributor, I want a single WSL setup guide that walks me from zero to running VS Code DevContainers, and I want all project documentation discoverable from the README.

Description: Rewrote wsl-manager.md as the single WSL Manager doc — a user-facing tool guide with commands, a DevContainer setup chapter (absorbing all content from wsl-devcontainer-setup.md), troubleshooting, and technical reference. Dropped internal/stale content (phase history, remaining checklists, future enhancements, SpecKit references). Deleted wsl-devcontainer-setup.md and wsl-podman-setup.md. Updated README to link one WSL doc (wsl-manager.md). Removed orphan BUG-002-vscode-wsl-interop-fix.md (content already in backlog). Subsequently updated the walkthrough to use Ubuntu-24.04 LTS as the recommended distribution, added a WSL global settings step (.wslconfig with cgroups v2, mirrored networking, DNS tunneling, auto-proxy), and added Keypirinha tips where users enter a WSL distribution.

Acceptance Criteria:

  • wsl-manager.md is the single WSL Manager doc (commands, DevContainer walkthrough, troubleshooting, reference)
  • DevContainer content from wsl-devcontainer-setup.md absorbed as a chapter in wsl-manager.md
  • wsl-devcontainer-setup.md and wsl-podman-setup.md deleted
  • Guide follows linear workflow: install distro → setup user → container runtime (Docker/Podman) → manual config → verify
  • Shared steps (SSH agent, Git config, VS Code settings) written once, not duplicated per runtime
  • Docker and Podman each have a self-contained subsection within the container runtime step
  • Guide matches actual wsl-manager commands and implementation
  • Internal/stale content dropped (phase history, checklists, SpecKit refs, AI-generated options)
  • All docs files reachable from README (directly or via a documentation section)
  • README links one WSL entry (wsl-manager.md), not two
  • BUG-002-vscode-wsl-interop-fix.md content consolidated into backlog entry and standalone file removed
  • No dead links
  • README restructured: WSL section concise, More Features section, Development docs grouped
  • All doc pages have back-to-README navigation links (top and bottom)
  • Walkthrough uses Ubuntu-24.04 as the recommended distribution (LTS version)
  • Walkthrough includes a WSL global settings step (.wslconfig: cgroups v2, mirrored networking, DNS tunneling, auto-proxy)
  • Keypirinha tip added wherever a WSL distribution is entered interactively

← Back to Backlog