Comprehensive documentation for Openwater's open-source medical device platforms.
Live Site: https://docs.openwater.health
Openwater is democratizing medical device innovation through open-source hardware and software platforms:
- OpenLIFU: Low Intensity Focused Ultrasound for non-invasive neuromodulation
- OpenMOTION: Near-infrared optical imaging for blood flow and oxygenation monitoring
Mission: Reduce medical device development costs from $119M to $15M through open-source collaboration, serving 3.5 billion underserved people globally.
docs/
├── getting-started/ # Installation and quickstart guides
├── openlifu/ # OpenLIFU platform documentation
├── openmotion/ # OpenMOTION platform documentation
├── hardware/ # Hardware assembly and BOM
├── community/ # Community guidelines and governance
├── research/ # Academic collaborations and publications
├── resources/ # Tutorials, videos, and FAQ
└── about/ # Mission, team, licensing
- Python 3.9 or higher
- pip package manager
- Git
# Clone repository
git clone https://github.com/OpenwaterHealth/openwater-docs.git
cd openwater-docs
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt# Serve with hot-reload at localhost:8000
mkdocs serve
# Build static site
mkdocs build
# Deploy to GitHub Pages (maintainers only)
mkdocs gh-deploy- Run
mkdocs serve - Open http://localhost:8000 in your browser
- Edit markdown files - changes appear instantly
We welcome documentation contributions! See our Contributing Guide.
- Fork this repository
- Create a feature branch (
git checkout -b docs/my-improvement) - Make your changes
- Test locally with
mkdocs serve - Commit with clear message (
git commit -m "docs: Add installation troubleshooting") - Push to your fork (
git push origin docs/my-improvement) - Open a Pull Request
- Use clear, simple language
- Include code examples
- Add diagrams where helpful
- Follow the Google Developer Documentation Style Guide
- Test all code examples
- Keep line length to 100 characters for readability
- MkDocs: Static site generator
- Material for MkDocs: Beautiful, responsive theme
- GitHub Pages: Free hosting
- GitHub Actions: Automated deployment
openwater-docs/
├── .github/
│ └── workflows/
│ └── deploy.yml # CI/CD for automated deployment
├── docs/ # Documentation source files
│ ├── assets/ # Images, logos, icons
│ ├── stylesheets/ # Custom CSS
│ ├── javascripts/ # Custom JavaScript
│ └── [content folders]/ # Documentation organized by topic
├── overrides/ # Theme customization
├── mkdocs.yml # MkDocs configuration
├── requirements.txt # Python dependencies
└── README.md # This file
Documentation is automatically deployed to https://docs.openwater.health when changes are pushed to the main branch.
- Push to
mainbranch or merge PR - GitHub Actions runs
mkdocs build - Site is deployed to GitHub Pages
- Changes are live in 1-2 minutes
# Build and deploy in one command
mkdocs gh-deploy
# Or build first, then deploy
mkdocs build
mkdocs gh-deploy --force- Discord: Join our community
- GitHub Issues: Report bugs or request features
- Email: community@openwater.health
Documentation is licensed under CC BY 4.0.
Code examples in documentation are licensed under Apache License 2.0.
- Main Website: openwater.health
- Documentation: docs.openwater.health
- GitHub Organization: OpenwaterHealth
- Discord Community: discord.gg/openwater
Openwater | Open Source, Always | Building the Linux of Medical Devices