The kube-rs website is a documentation site built with MkDocs that serves the kube.rs project homepage.
The project solves the problem of maintaining centralized, accessible documentation for the kube-rs Rust Kubernetes client library. It uses MkDocs with the Material theme to generate a static website from Markdown documents, hosted on GitHub Pages. The site supports wiki-style cross-links between documents, enabling intuitive navigation through interconnected content. Local preview and editing workflows are supported through standard MkDocs tooling and markdown language servers.
The site is organized through the mkdocs.yml configuration file's nav section, which dictates the webpage structure. Developers editing the documentation should be aware that certain files are synchronized from external sources and marked with generated headers; these canonical versions live outside this repository and should be edited at their original locations rather than in this repo. The sync.sh script manages this synchronization process. For local development, contributors can install dependencies in a virtualenv and run mkdocs serve to preview changes, with optional support for wiki-link resolution through markdown language servers or the Foam extension for VS Code.
The project maintains active release automation through GitHub Actions workflows. Development activity shows consistent engagement with the documentation infrastructure, as evidenced by the maintained release pipeline and the structured approach to managing external file synchronization.
