Skip to content

sc-013.md

Latest commit

 

History

History
56 lines (44 loc) · 3.35 KB

sc-013.md

File metadata and controls

56 lines (44 loc) · 3.35 KB

← Back to Backlog

[SC-013] COMPLETED - Fix and enhance documentation

Status: Done (2026-03-25) Priority: Medium Component: docs/wsl-manager.md

Summary: As a user, I want the documentation to provide guidance for both TUI and CLI execution, with detailed command descriptions and a DevContainer setup guide that recommends Podman + DevPods, so that I can follow the walkthrough regardless of my preferred workflow and tooling.

Description: The WSL Manager documentation needs several improvements across the entire document:

1. Replace "interactive menu" with "TUI"

  • Rename all references from "interactive menu" to TUI (Terminal User Interface)
  • Add a short explanation of what TUI means where first introduced (e.g., "TUI (Terminal User Interface) — a menu-driven interface launched by running the script without arguments")
  • Each command in the Commands section should use TUI: and CLI: labels instead of Menu: and CLI:

2. Expand command descriptions

  • Every command should include a "This command:" section followed by a bullet list of what the command performs and which files/systems are touched
  • Model after the existing Setup User Account description which already has this pattern
  • Commands currently lacking this: Install New Distribution, Clone Distribution, Update Distribution, Setup Proxy, Remove Distribution, Terminate Distribution

3. Remove cross-references from commands to the setup guide

  • Individual command descriptions should NOT reference "see DevContainer Setup for the full walkthrough"
  • Commands should be self-contained descriptions; the setup guide is a separate walkthrough that references the commands, not the other way around

4. Rename and expand "VS Code DevContainer Setup"

  • Rename section from "VS Code DevContainer Setup" to "DevContainer Setup"
  • Include DevPods as an alternative to the VS Code DevContainer extension
  • Mention that DevPods have the advantage of being IDE-independent (not tied to VS Code)
  • Update the table of contents link accordingly

5. Add TUI/CLI guidance to DevContainer Setup steps

  • Each step in the walkthrough should show both TUI: and CLI: instructions
  • Users following the guide via the TUI should know which menu option corresponds to each step and what prompts to expect

6. Recommend Podman + DevPods

  • The guide should recommend Podman and DevPods as the preferred solution for development
  • Docker and VS Code DevContainer extension remain documented as alternatives
  • Reasoning: Podman is rootless/daemonless (more secure, lighter), DevPods are IDE-independent (not locked into VS Code)

Acceptance Criteria:

  • All "interactive menu" references replaced with "TUI" including a short explanation
  • Every command uses TUI:/CLI: labels
  • Every command has a "This command:" bullet list describing what it does
  • No command description references the DevContainer Setup section
  • "VS Code DevContainer Setup" renamed to "DevContainer Setup" with DevPods as alternative
  • DevPods' IDE-independence advantage is mentioned
  • Each DevContainer Setup step shows both TUI: and CLI: instructions
  • Podman + DevPods recommended as preferred solution
  • Docker + VS Code DevContainer extension documented as alternative
  • All existing tests continue to pass

← Back to Backlog