This repository holds the documentation for Venusian: the core framework, Surface (displays and graphics), and the ecosystem of extensions, GPIO modules and packages around them. The online version lives at venusian.projectsaturnstudios.com/docs.
Each release line has its own branch: 0.10.x documents Venusian 0.10. Pages are plain Markdown, one file per page, under framework/, surface/ and ecosystem/. documentation.md is the sidebar: its ## entries are the top-level sections, and its links set the reading order.
Links between pages use the {{version}} placeholder, which the site replaces with the branch being read:
[Service Container](/docs/{{version}}/framework/architecture-concepts/container)Thank you for considering contributing to the Venusian documentation! Open a pull request against the branch of the release line you are documenting. A new page needs an entry in documentation.md; the link check fails the pull request when a sidebar entry has no page, a page has no sidebar entry, or a /docs/{{version}}/… link points at a page that does not exist.
In order to ensure that the Venusian community is welcoming to all, please review and abide by the Code of Conduct.
The Venusian documentation is open-sourced software licensed under the MIT license.