docs: add CLI reference, Claude Code guide, and expand README#9
Merged
Conversation
Replace the minimal README with comprehensive documentation: safety guarantees, full configuration reference, quick start walkthrough, command tables, output format examples, and error handling overview. Add docs/cli-reference.md with exhaustive coverage of all commands, flags, output schemas, and error codes. Add docs/claude-code-guide.md with setup instructions, a CLAUDE.md snippet, and workflow examples. Remove PLAN.md (implementation plan superseded by user-facing docs).
cboone
force-pushed
the
docs/update-docs
branch
from
281f885 to
651fb7c
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the jm project’s user-facing documentation by replacing the minimal README with a more complete guide and adding dedicated reference docs for CLI usage and Claude Code workflows.
Changes:
- Add a comprehensive CLI reference covering commands, flags, output schemas, and error codes.
- Add a Claude Code integration guide with setup instructions and workflow examples.
- Expand
README.mdwith safety guarantees, configuration reference, quick start, and links to the detailed docs (and add plan documents underdocs/plans/).
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/plans/todo/dapper-sauteeing-taco.md | Adds a documentation plan describing intended deliverables and structure |
| docs/plans/done/PLAN.md | Adds an implementation plan/design doc content under docs/plans/done/ |
| docs/CLI-REFERENCE.md | New exhaustive CLI reference (commands, formats, schemas, errors) |
| docs/CLAUDE-CODE-GUIDE.md | New Claude Code setup + workflow guide that links to the CLI reference |
| README.md | Rewrites README into a fuller landing page with safety/config/usage and doc links |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replace the minimal README with comprehensive documentation: safety
guarantees, full configuration reference, quick start walkthrough,
command tables, output format examples, and error handling overview.
Add docs/cli-reference.md with exhaustive coverage of all commands,
flags, output schemas, and error codes. Add docs/claude-code-guide.md
with setup instructions, a CLAUDE.md snippet, and workflow examples.
Remove PLAN.md (implementation plan superseded by user-facing docs).