Skip to content

docs: improve README with full CLI reference, --platform docs, and Troubleshooting#19

Merged
AngryJay91 merged 1 commit intomainfrom
docs/issue-16-readme
Mar 31, 2026
Merged

docs: improve README with full CLI reference, --platform docs, and Troubleshooting#19
AngryJay91 merged 1 commit intomainfrom
docs/issue-16-readme

Conversation

@AngryJay91
Copy link
Copy Markdown
Owner

Closes #16

Changes

  • CLI Reference now covers all 5 commands: init, hydrate, deploy, migrate, doctor (previously missing deploy and migrate)
  • Per-command detail sections with usage examples, prerequisites, and behavior notes
  • --platform option documented with a table of supported adapters (claude-code, codex, gemini) and examples
  • Troubleshooting section added covering 9 common issues:
    • Existing structure detected on init
    • Templates not updating
    • deploy fails (wrangler.toml missing, not authenticated)
    • migrate duplicate column warnings
    • MCP connection not working
    • Oscar/slash commands missing
    • spec-site startup errors
    • doctor failures

Constraints respected

  • Only README.md modified
  • No TypeScript/JavaScript code touched
  • project.yaml.example checked — all fields present, no additions needed

@AngryJay91 AngryJay91 force-pushed the docs/issue-16-readme branch from a8868f7 to 1d5420f Compare March 31, 2026 02:15
@AngryJay91 AngryJay91 merged commit f05d4e1 into main Mar 31, 2026
2 checks passed
@AngryJay91 AngryJay91 deleted the docs/issue-16-readme branch March 31, 2026 02:18
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.

P2-4: README/문서 보강 (deploy, migrate, --platform)

1 participant