OpenwaterHealth / OpenwaterHealth/openwater-docs
Add an "Openwater Repository Guide" describing how the repositories fit together
@HussainAther is already working on this.
Since Aug 6, 2026.
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- Avg merge
- 1m
- Merged PRs (30d)
- 4
Description
Problem
As a new contributor, it takes some time to understand how the different Openwater repositories relate to one another.
The documentation currently covers OpenLIFU and OpenMotion independently, but there doesn't appear to be a single page explaining the overall repository ecosystem and where different types of work belong.
For example:
- Which repository contains the SDK?
- Which repository contains the operator or clinical application?
- Where should documentation changes go?
- Which repositories are libraries versus end-user applications?
Proposal
Add a short "Repository Guide" page to the documentation that introduces the major repositories and how they relate.
For example:
OpenMotion
openmotion-sdk
↓
openmotion-bloodflow-app
OpenLIFU
openlifu-sdk
↓
openlifu-operator-interface
Documentation
openwater-docs
Each repository could have a brief description such as:
| Repository | Purpose |
|---|---|
| openmotion-sdk | Core SDK, hardware communication, processing pipeline |
| openmotion-bloodflow-app | Clinical/research desktop application |
| openlifu-sdk | Core LIFU SDK |
| openlifu-operator-interface | Operator-facing application |
| openwater-docs | Shared documentation site |
Optionally, the page could also include links to each repository's README and contribution guidelines.
Motivation
This would help new contributors quickly understand:
- where new features belong;
- where to report bugs;
- where to submit documentation changes;
- how the SDKs and applications relate to one another.
I think it would make onboarding considerably easier without changing any existing documentation structure.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.