Greg Gauthier
cd47686679
- Simplified README.md by moving detailed command docs, workflows, and development info to dedicated user-guide/ and developer-guide/ directories. - Created index.md files for both guides to improve navigation. - Extracted individual command guides (e.g., chat.md, edit.md) into user-guide/ for focused, maintainable documentation. - Moved architecture, configuration, and troubleshooting to developer-guide/. - Updated README links to point to the new docs structure.
1.6 KiB
1.6 KiB
Grokkit Documentation
Welcome to the Grokkit documentation. Grokkit is a fast, native Go CLI that integrates Grok AI into your daily development and git workflows.
Whether you're looking for quick answers, AI-powered file editing, or complex multi-step automated workflows, Grokkit provides the tools to enhance your productivity.
Table of Contents
- User Guide — Comprehensive documentation for all Grokkit commands and features.
- Grokkit Workflows — Learn how to integrate Grokkit into your development cycle effectively.
- Safety & Change Management — Learn how Grokkit integrates with Git to keep your codebase stable and safe.
- Configuration Guide — Detailed information on how to configure Grokkit via environment variables and config files.
- Developer Guide — Resources and guidelines for contributing to Grokkit development.
- Development Overview — Build instructions, project structure, and the standard TODO workflow.
- Architecture Overview — Deep dive into the design principles, project structure, and technical implementation of Grokkit.
- Troubleshooting — Common issues and their solutions.