This repository documents the Blue Robotics' Cockpit software.
The documentation is generated using the Zola static site generator.
- Each branch covers a minor release (
X.y) of the software, including any patches (X.Y.z) of that release- The
latestbranch covers the development state in the BlueOSmasterbranch, but is not expected to be consistently up to date - The
betabranch covers the latest beta release, and is intended to at least minimally describe all included features
- The
- For ease of contribution, and to keep the search index independent between versions, each branch is built independently
- Documentation content is in the
contentdirectory - The theme is provided as a submodule in the
themesdirectory
New features should first be documented in latest, and subsequently branched into beta and a stable version toegther with the software release cycle.
Improved documentation for existing features should at least be added to latest, and ideally also cherry-picked into the existing beta and stable-versioned branches as relevant.
Detailed contribution information can be found in CONTRIBUTING.md
This documentation is licensed under CC BY-NC-SA 4.0
