mirror of
https://github.com/holos-run/holos.git
synced 2026-03-20 01:04:59 +00:00
117a00334f
The docs for v1alpha4 have the right information, but in the wrong places. The most important bits are tucked away in the Core API docs. One of our first users entirely missed the `holos generate platform` command mentioned in the Helm guide. We'll fix this by organizing the docs into two distinct categories. First, a tutorial written as a series progressively building up the minimum knowledge to use holos effectively and gain the benefits. Think of it as a tour of the essential bits. The second category are focused topics which stand alone. They're the things most people using holos will need to know eventually, but aren't essential for everyone to know. For example, Clusters and Fleets will move from the Author API to stand alone examples of how to implement these features if necessary. Then there's a Glossary which serves as the place to describe our concepts and domain specific language. Finally there's the API documentation which should be cut down to the specific version. The next release version will be v1alpha5. Attribution: We're copying the Tokio docs structure, it's concise and a similar size and complexity to our own project. The Go docs are also an inspiration, but the project is much larger so not directly comparable. The organization of https://go.dev/doc/ feels complete at first glance, despite the size and age of the project. The site also makes clear who each section is for without needing to come right out and say it. Getting started, Using and understanding Go, Writing modules, using databases, etc...
29 B
29 B
Architecture
Coming soon.