Skip to content

docs: create USER-GUIDE.md with configuration and advanced usage#49

Merged
snipcodeit merged 1 commit intomainfrom
issue/26-create-docs-user-guide-md
Feb 27, 2026
Merged

docs: create USER-GUIDE.md with configuration and advanced usage#49
snipcodeit merged 1 commit intomainfrom
issue/26-create-docs-user-guide-md

Conversation

@snipcodeit
Copy link
Owner

Summary

  • Created comprehensive docs/USER-GUIDE.md covering the full MGW user experience from installation through advanced usage
  • Covers .mgw/ directory structure, config.json options, all 15 commands with usage examples, GSD route explanation, dependency ordering (Kahn's algorithm), worktree isolation, status comment formats, cross-references, failure recovery, and FAQ
  • Target audience: developers who have installed MGW and run /mgw:help but want deeper understanding

Closes #26

Milestone Context

  • Milestone: v1 — Documentation & Developer Experience
  • Phase: 5 — Extended Documentation
  • Issue: 2 of 4 in milestone

Changes

  • docs/
    • USER-GUIDE.md — New file (1311 lines) covering installation, configuration, command reference, workflow walkthroughs, GSD routes, dependency ordering, worktree isolation, status comments, cross-references, advanced usage, failure recovery, GSD integration, troubleshooting, and FAQ

Test Plan

  • Verify all command names match current codebase (help.md, README.md)
  • Verify .mgw/ directory structure matches state.md workflow
  • Verify pipeline stages match state schema (new → triaged → planning → executing → verifying → pr-created → done)
  • Verify GSD route names match VALID_GSD_ROUTES in template-loader.cjs
  • Verify cross-refs link types match cross-refs schema in state.md
  • Verify CLI flags match Commander.js options in bin/mgw.cjs
  • Review for broken internal links to ARCHITECTURE.md and CONTRIBUTING.md

Comprehensive user guide covering installation, configuration,
command reference, workflow walkthroughs, GSD route explanation,
dependency ordering (Kahn's algorithm), worktree isolation,
status comments, cross-references, advanced usage patterns,
failure recovery, GSD integration, troubleshooting, and FAQ.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added the documentation Documentation changes label Feb 27, 2026
@snipcodeit snipcodeit merged commit 905a574 into main Feb 27, 2026
1 check passed
@snipcodeit snipcodeit deleted the issue/26-create-docs-user-guide-md branch February 27, 2026 04:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create docs/USER-GUIDE.md with configuration and advanced usage

1 participant