Skip to main content
Version: Next 🚧

Contributor Getting Started

This section is for engineers and collaborators who need local setup guidance plus the project rules for shipping changes safely.

First steps​

  1. Clone the repository.
  2. Verify the app build path with clickable desktop.
  3. Review the technical docs to understand the QML, JavaScript, and Python split.
  4. Review the PR guidance before opening changes.

Working on the docs site​

The docs site is now part of the repository:

cd website
npm install
npm run start

Contribution expectations​

Contributors should update documentation when changes are:

  • user-visible
  • architecture-visible
  • setup-related
  • release-impacting