Skip to content

docs: create GitHub Wiki for MGW documentation#65

Merged
snipcodeit merged 1 commit intomainfrom
issue/54-create-github-wiki
Feb 27, 2026
Merged

docs: create GitHub Wiki for MGW documentation#65
snipcodeit merged 1 commit intomainfrom
issue/54-create-github-wiki

Conversation

@snipcodeit
Copy link
Owner

Summary

  • Create comprehensive GitHub Wiki with 7 pages covering all MGW documentation: Home, Getting Started, Commands Reference, Workflow Guide, Architecture, Configuration, and Troubleshooting
  • All pages cross-linked using [[Page Name]] wiki syntax with a _Sidebar.md for persistent navigation
  • Include wiki/deploy.sh script to push pages to the wiki git repo once wiki is initialized via GitHub web UI
  • Add wiki link to README Documentation table

Closes #54

Milestone Context

  • Milestone: v1 — Wiki & Final Polish
  • Phase: 11 — Wiki
  • Issue: 2 of 3 in milestone

Changes

  • wiki/Home.md — Overview, quick navigation table, key concepts (two-layer model, pipeline stages, GSD routes)
  • wiki/Getting-Started.md — Prerequisites, 4 installation options, first pipeline walkthroughs, npx vs full install comparison
  • wiki/Commands-Reference.md — All 15 /mgw:* commands with usage, flags, examples, and CLI equivalents
  • wiki/Workflow-Guide.md — End-to-end walkthroughs (greenfield, existing issues, manual control, multi-session), detailed pipeline stages, milestone execution flow, status comments, GSD routes
  • wiki/Architecture.md — Two-layer model, delegation boundary, pipeline data flow, state management, agent delegation model, slash command anatomy, CLI architecture, shared workflow system, GSD artifact flow
  • wiki/Configuration.md — Full .mgw/ directory structure, project.json schema, issue state schema, cross-refs.json, environment variables, CLI flags, templates, slug format
  • wiki/Troubleshooting.md — Authentication, GSD, state, worktree, pipeline, API, dependency, and slash command issues with quick reference table
  • wiki/_Sidebar.md — Persistent sidebar navigation for all wiki pages
  • wiki/deploy.sh — Script to clone wiki repo and push all pages
  • README.md — Add wiki link to Documentation table

Deployment Note

The GitHub wiki git repository does not exist until the first page is created through the GitHub web UI. To deploy:

  1. Navigate to https://github.com/snipcodeit/mgw/wiki
  2. Click "Create the first page" and save any content
  3. Run cd wiki && bash deploy.sh to push all pages

Test Plan

  • Verify all wiki .md files render correctly as standalone markdown
  • Verify all [[Page Name]] links resolve to valid filenames (Page-Name.md)
  • Verify _Sidebar.md includes links to all 7 pages
  • Verify deploy.sh script runs without errors (after wiki is initialized)
  • Verify README wiki link points to correct URL
  • After deployment, verify cross-page navigation works in GitHub wiki UI

🤖 Generated with Claude Code

Add wiki/ directory containing 7 wiki pages plus sidebar and deploy
script. Pages cover: Home (overview + navigation), Getting Started
(installation, prerequisites, first run), Commands Reference (all
/mgw:* commands with usage and examples), Workflow Guide (end-to-end
walkthroughs), Architecture (two-layer model, pipeline flow, state
management), Configuration (.mgw/ directory, schemas, settings), and
Troubleshooting (common issues and solutions).

All pages are cross-linked using GitHub wiki [[Page Name]] syntax.
The deploy.sh script pushes pages to the wiki git repo once the wiki
is initialized via the GitHub web UI.

Also adds wiki link to the README Documentation table.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@github-actions github-actions bot added the documentation Documentation changes label Feb 27, 2026
@snipcodeit snipcodeit merged commit c520eb8 into main Feb 27, 2026
1 check passed
@snipcodeit snipcodeit deleted the issue/54-create-github-wiki branch February 27, 2026 07:03
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 GitHub Wiki for MGW documentation

1 participant