Skip to content

docs: add A-to-Z Claude Code plugin guide#109

Merged
dadachi merged 1 commit into
mainfrom
docs/plugin-a-to-z-guide
May 25, 2026
Merged

docs: add A-to-Z Claude Code plugin guide#109
dadachi merged 1 commit into
mainfrom
docs/plugin-a-to-z-guide

Conversation

@dadachi
Copy link
Copy Markdown
Contributor

@dadachi dadachi commented May 25, 2026

What

Adds docs/PLUGIN-GUIDE.md — a complete, follow-top-to-bottom guide to the Claude Code plugin, and cross-links it from both READMEs.

The existing plugin/README.md is a concise reference card; this fills the gap with a tutorial-style walkthrough someone can follow start to finish.

Contents of the guide

  • Prerequisites — split into always-required (Node 22, API key, substrate env vars) vs. walk-app-only (simulators/emulator, WebDriverAgent on :8100, Rails)
  • Install — marketplace (recommended), local --plugin-dir, and the raw MCP server for non-Claude-Code assistants
  • Verify/help + /mcp, plus the two load-bearing .mcp.json pins (@latest cwd-shadowing, mobile-mcp@0.0.54)
  • generate-app end to end — invoke, overrides, the report.json schema + layer meanings, and failure handling
  • walk-app end to end — getting the app onto a device, device readiness, Rails-up + the iOS SIMCTL_CHILD_<PRODUCT>_API_* passthrough, the capture-and-walk loop
  • Full reference — every CLI flag and env var in two tables
  • Troubleshooting & FAQ — keyed to the known failure modes

Cross-links

  • plugin/README.md — callout pointing to the guide, framing itself as the reference card
  • README.md — plugin paragraph now links both the reference card and the guide

Docs-only; no code changes. Self-contained but cross-links SPEC.md / validation-report.md / main README, and defers to the SKILL.md files as the machine-facing source of truth.

🤖 Generated with Claude Code

Full follow-top-to-bottom walkthrough for the plugin: prerequisites,
install (marketplace / --plugin-dir / raw MCP), verifying via /help and
/mcp, both skills end-to-end (generate-app report schema + failure
handling; walk-app device readiness + the iOS SIMCTL_CHILD passthrough),
a full reference table of flags and env vars, and troubleshooting keyed
to the known failure modes.

plugin/README.md stays the concise reference card; both it and the main
README now cross-link the guide.
@dadachi dadachi merged commit d6ae26b into main May 25, 2026
1 check passed
@dadachi dadachi deleted the docs/plugin-a-to-z-guide branch May 25, 2026 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant