Overview
You’ll author and refine QDoc for Genesis-X—aligning with our style guide, improving discoverability, and ensuring examples compile and run. Work is async and collaborative via issues/PRs.
What you’ll do
- Draft and edit **QDoc pages** (modules, classes, guides).
- Create **minimal examples** (QML/C++) that compile and render correctly.
- Improve **naming, cross-links, and index pages** for easier navigation.
- Collaborate with engineers on accuracy and style consistency.
What we’re looking for
- Familiarity with **Qt/QML** (Qt 6 preferred) and reading C++ headers.
- Experience with **QDoc** or similar tooling (Doxygen/Sphinx/JSDoc).
- Clear writing, attention to detail, consistent tone.
Time commitment
~2–4 hrs / week
Type
Volunteer
Nice to have
- Experience with **Qt Quick 3D** or physics/simulation concepts.
- Prior work maintaining **docs pipelines** in CI.
How to apply
Send a short intro and (optionally) samples of past technical writing.