- 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.
802 B
802 B
Developer Guide
Welcome to the Grokkit Developer Guide. This section contains resources and guidelines for those who want to contribute to Grokkit's development or understand its internal workings.
Resources
- 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.
- Configuration Guide — Detailed information on how to configure Grokkit via environment variables and config files.
- Troubleshooting — Common issues and their solutions encountered during development or deployment.
- Back to Documentation Index