Improve README onboarding section - #489
Conversation
| @@ -1,18 +1,28 @@ | |||
| # openlifu | |||
| # Open-LIFU | |||
There was a problem hiding this comment.
The python library is called openlifu
There was a problem hiding this comment.
updated the wording to consistently refer to the openlifu Python library while keeping the project name as Open-LIFU where appropriate.
| [](https://github.com/OpenwaterHealth/OpenLIFU-python/actions) | ||
| [](https://openlifu.readthedocs.io/en/latest/?badge=latest) | ||
| Open-LIFU is an open-source Python platform for planning, simulating, and controlling low-intensity focused ultrasound (LIFU) experiments. It helps researchers and developers build reproducible focused ultrasound workflows for planning, medical imaging, acoustic simulation, hardware communication, and experimental research while continuing the capabilities of the original MATLAB open-TFUS toolbox. | ||
|
|
||
| [](https://pypi.org/project/openlifu/) | ||
| [](https://pypi.org/project/openlifu/) | ||
| ## Who is Open-LIFU for? | ||
|
|
||
| [](https://github.com/OpenwaterHealth/OpenLIFU-python/discussions) |
There was a problem hiding this comment.
Why remove badges?
| [](https://github.com/OpenwaterHealth/OpenLIFU-python/discussions) | ||
| **Developers** can contribute to an actively evolving scientific software platform for focused ultrasound research, medical imaging, and hardware integration. | ||
|
|
||
| <!-- SPHINX-START --> |
There was a problem hiding this comment.
This tells the documentation's home page where to start: https://openlifu.readthedocs.io/en/latest/includeme.html
|
ty for catching these. restored the openlifu heading, all existing badges, and the SPHINX-START marker, and moved the new onboarding content below them. |
ebrahimebrahim
left a comment
ebrahimebrahim
left a comment
There was a problem hiding this comment.
Thanks for fixing! Added more comments
|
Thanks for the suggestions. I updated the onboarding links to prioritize the Quickstart guide, API documentation, Community Hub, and Good First Issues. I left GitHub Discussions/Discord out of the new onboarding until there's broader consensus on which communication channels should be promoted. |
There was a problem hiding this comment.
Thank you, it looks great!
I think just the commit message and formatting needs to be fixed now for the CI to pass.
The commit message can reference #338
860c452 to
66cd8fd
Compare
2 participants
Closes #461
Summary
This PR improves the onboarding section at the top of the README to help first-time visitors quickly understand the project before reaching the installation instructions.
The new introduction:
The existing installation instructions and technical setup documentation below the onboarding section are left unchanged.
Motivation
The README is the first entry point for many potential users and contributors. This update provides context about the project, its intended audiences, its current development status, and where new contributors can get involved before diving into installation and technical documentation.
Testing