aRustyDev / aRustyDev/ccgram

Write usage documentation

Open
#18 0 comments 0 reactions 0 assignees View on GitHub
docs
Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Summary
Write comprehensive documentation for using ccgram.

## Success Criteria
- [ ] Installation instructions (pip install, from source)
- [ ] Quick start guide with examples
- [ ] API reference documented
- [ ] CLI usage documented (if applicable)
- [ ] Configuration options explained
- [ ] Troubleshooting section
- [ ] Contribution guidelines

## Documentation Sections
1. **README.md**: Update with installation and quick start
2. **docs/getting-started.md**: Detailed setup guide
3. **docs/api.md**: API reference
4. **docs/configuration.md**: Config options
5. **CONTRIBUTING.md**: How to contribute

## Examples to Include
\`\`\`python
from ccgram import generate_commit

# Simple usage
message = generate_commit(diff="added login button")
# Output: "feat(ui): add login button"

# With options
message = generate_commit(
diff="fixed null pointer in auth",
type_hint="fix",
scope_hint="auth"
)
\`\`\`

## Quality Bar
- A new user can install and run in <5 minutes
- All public APIs documented
- Examples are copy-pasteable

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.