README.md

Overview

This repository documents the Blue Robotics' BlueOS software.

The documentation is generated using the Zola static site generator, together with BlueTheme.

Structure

• Each branch covers a minor release (X.y) of the software, including any patches (X.Y.z) of that release
  • The latest branch covers the development state in the BlueOS master branch, but is not expected to be consistently up to date
    • It is intended to at least minimally describe all included features in the latest available beta release
  • The stable branch covers the latest stable version, and is intended to sufficiently describe all included features
• For ease of contribution, and to keep the search index independent between versions, each branch is built independently
• Documentation content is in the content directory
• The theme is provided as a submodule in the themes directory

Contributing

New features should first be documented in latest, then cherry-picked into stable as part of the software release cycle.

Improved documentation for existing features should at least be added to latest, and ideally also cherry-picked into the existing stable and numbered stable version branches as relevant.

Detailed contribution information can be found in CONTRIBUTING.md

License

This documentation is licensed under CC BY-NC-SA 4.0