Your First Documentation
Understanding what CodeContext generated for you
What Was Generated?
README.md
Your project's main documentation file. Includes:
- Project overview and description
- Installation instructions
- Usage examples
- API documentation (if applicable)
CHANGELOG.md
Version history extracted from your git commits:
- Semantic version numbers
- Grouped by release dates
- Categorized changes
- Links to commits
README Structure
Project Title & Badges
Your project name with relevant badges (version, license, build status)
Description
A clear, concise explanation of what your project does
Table of Contents
Quick navigation to all major sections
Installation
Step-by-step setup instructions with code blocks
Usage
Examples showing how to use your project
Contributing & License
Guidelines for contributors and legal information
Customizing Your Documentation
Manual Edits
Feel free to edit the generated files! CodeContext creates a great starting point, but you can customize everything to match your needs.
$ vim README.md # Edit with your favorite editorUpdate After Changes
When you make significant code changes, regenerate your docs:
$ codecontext update # Regenerate documentationAdd Custom Sections
CodeContext preserves custom sections when updating. Add your own content between:
<!-- CUSTOM-SECTION-START -->
Your custom content here...
<!-- CUSTOM-SECTION-END -->Best Practices
- Keep it Updated: Run
codecontext updateafter major changes - Add Examples: Include code snippets and real-world usage examples
- Use Badges: Add status badges for CI/CD, coverage, and version
- Include Visuals: Add diagrams, screenshots, or GIFs when helpful
- Version Your Docs: Tag releases to match documentation versions
Common Questions
Can I delete sections I don't need?
Yes! The generated documentation is just a starting point. Remove any sections that don't apply to your project.
How do I add more documentation files?
Use codecontext generate [type] to create additional documentation like CONTRIBUTING.md or API.md (Pro feature).
Will updates overwrite my changes?
CodeContext intelligently merges updates, preserving your custom content. Always commit your changes before updating to be safe.