| title |
|---|
SideroLabs documentation contribution guide |
Welcome to the official SideroLabs documentation, we are excited that you want to contribute!
This guide walks you through how to make changes to the SideroLabs Docs, which power the documentation for Talos, Omni, and the shared Kubernetes Guides both projects rely on.
Whether you’re fixing a typo or adding a brand-new page, this document explains how to get started, how the docs are structured, and how to make sure your contribution is clear, consistent, and high-quality.
All SideroLabs documentation is housed in a single repository, organized under the public/ folder:
public/
├── talos/ → Versioned Talos docs
├── omni/ → Unversioned Omni docs
└── kubernetes-guides/ → Unversioned Kubernetes guides
The documentation is written in MDX format. You can learn more about MDX syntax from the Mintlify documentation and the official MDX website.
The Docs repository issues page lists known gaps or inaccuracies in the documentation. These issues are open for anyone to contribute to, whether you’re part of the SideroLabs team or a member of the community.
Sometimes, users also share doc-related feedback or questions directly in the Talos GitHub repository, usually under the Docs_improvement label.
Issues with the Docs_improvement label might be resolved in the Talos repo or migrated to the docs repo for further updates.
To understand how a Docs_improvement issue moves from open to merged, check out the Documentation Labeling and Workflow guide.
Before you start writing or making any contributions, please review our Style Guide. It explains how we write, format, and structure documentation at SideroLabs.
Following the style guide helps keep every contribution consistent, clear, and approachable, no matter who wrote it.
When you're ready to contribute, head over to our How to contribute to the SideroLabs documentation guide. It walks you through, step by step, how to create a pull request and submit your documentation changes.