Roadmap¶
This page describes planned directions for the QSP documentation and ecosystem.
Note
This roadmap reflects current plans and priorities. It is subject to change as the ecosystem evolves.
Documentation roadmap¶
Near-term¶
- [ ] API reference pages for each package (auto-generated from source docstrings)
- [ ] Expanded example coverage for each package
- [ ] Tutorials for common end-to-end workflows
- [ ] Versioned documentation (per package release)
Medium-term¶
- [ ] Interactive examples (e.g., embedded notebooks or code playgrounds)
- [ ] Diagrams for detailed data flow within each package
- [ ] Comparison pages with adjacent libraries (e.g., SciPy, pyquaternion)
- [ ] FAQ and troubleshooting guides
Longer-term¶
- [ ] Multi-version docs hosting at
docs.rqmtechnologies.com/qsp - [ ] Localization support (if applicable)
- [ ] Contribution guide for community docs contributions
Ecosystem roadmap¶
The QSP ecosystem is actively developed. Documentation will be updated as packages evolve.
Package maturity¶
| Package | Status |
|---|---|
qsp-core |
Stable foundation |
qsp-fft |
Active development |
qsp-filter |
Active development |
qsp-modulation |
Active development |
qsp-orientation |
Active development |
qsp-stack |
Versioned with ecosystem |
Planned ecosystem expansions¶
These are areas under consideration for future packages or extensions within existing packages:
- Quaternionic wavelet transforms
- Adaptive and recursive filter designs
- Additional orientation estimation algorithms (EKF, UKF)
- Quaternionic neural network integration utilities
- Real-time signal processing support
Feedback¶
If you have suggestions for documentation topics or ecosystem features, open an issue in the relevant repository on GitHub.