K8sGPT Documentation is the documentation repository for K8sGPT, an AI-powered tool that brings Kubernetes troubleshooting and SRE capabilities to users through natural language interfaces.
The documentation addresses the need for clear, structured guidance on using K8sGPT within Kubernetes environments. It organizes content following the Diataxis framework, which separates material into getting started guides, end-to-end tutorials, feature reference documentation, and design explanations. This structure helps users find the right type of information depending on whether they are learning the tool, solving a specific problem, or understanding architectural decisions.
Teams adopting K8sGPT should use this documentation as their primary resource for installation, configuration, and operational use. The repository is designed for both newcomers seeking initial setup guidance and experienced users exploring advanced features. The documentation can be run locally using Docker, enabling contributors and users to preview changes before deployment. Anyone proposing new documentation content should familiarize themselves with the Diataxis framework to maintain consistency with the existing structure.
The project maintains active engagement with documentation quality, inviting users to report unclear sections through the issue tracker. Contributions follow the same guidelines as the main K8sGPT project, ensuring alignment between the tool and its documentation. The use of Docker for local development and the explicit adoption of a structured documentation framework indicate deliberate attention to both contributor experience and documentation maintainability.
