Skip to content

Comprehensive documentation refractor for robotic ultrasound workflow #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 23 commits into from
Jul 11, 2025
Merged

Comprehensive documentation refractor for robotic ultrasound workflow #181

merged 23 commits into from
Jul 11, 2025

Conversation

@mingxin-zheng
Copy link
Contributor

@mingxin-zheng mingxin-zheng commented Jul 6, 2025 •
edited
Loading

This PR addresses feedback on the robotic ultrasound experience by:

  • Restructure main README with quick start guide, detailed setup instructions,
    and comprehensive script catalog table
  • Split comprehensive simulation README into smaller individual files for references
    • Policy runner, simulation environments, teleoperation, evaluation
    • State machine, ultrasound raytracing, cosmos transfer1 integration
    • Imitation learning, utilities, and Holoscan apps
  • Clean up import statements in liver_scan_sm.py with proper isort formatting
  • Add reset.sh utility script for killing all workflow processes
  • Add missing init.py file for utils package
  • Improve documentation structure with jump-to-section navigation
  • Add troubleshooting section and system requirements clarification

Description

@mingxin-zheng mingxin-zheng marked this pull request as draft July 6, 2025 14:34
@mingxin-zheng
Copy link
Contributor Author

mingxin-zheng commented Jul 6, 2025

/build

@mingxin-zheng mingxin-zheng marked this pull request as ready for review July 7, 2025 15:10
@mingxin-zheng
Copy link
Contributor Author

mingxin-zheng commented Jul 7, 2025

/build

@mingxin-zheng mingxin-zheng changed the title fix documentation Comprehensive documentation refractor for robotic ultrasound workflow Jul 7, 2025
@mingxin-zheng
Copy link
Contributor Author

mingxin-zheng commented Jul 8, 2025

/build

KumoLiu
KumoLiu approved these changes Jul 8, 2025
View reviewed changes
Copy link
Contributor

@KumoLiu KumoLiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update, overall looks good to me.
Leave several minor comments inline.

@mingxin-zheng
Copy link
Contributor Author

mingxin-zheng commented Jul 9, 2025

/build

jjomier
jjomier reviewed Jul 9, 2025
View reviewed changes
@mingxin-zheng
fix documentation
800d40c 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
intermediate
6b1784a 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
add init
1e5aa52 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
add copy paste commands
94fb946 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
add resest script and fix import
6348b60 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
refractor readme
695c5cd 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix
c7b5a7c 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix dead links
3508740 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
autofix
ec5c1d2 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix links
5323476 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix
de99717 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
trailing space
70f8008 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix doc
8efb774 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
rearrange
2d4b9fa 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix comments, change what is expected to expected havior, add periods
b3d49a0 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
add jump to section for task
e7e2607 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix
ea74bc4 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
add docker reference in main readme
023f125 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
minor fixes
7973d97 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix sep and change name to IsaacLab task setting
eb21403 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix
3ea553d 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix link
544a361 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
fix comment
4d2b8ad 
Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
Copy link
Contributor Author

mingxin-zheng commented Jul 10, 2025

/build

3 similar comments
@mingxin-zheng
Copy link
Contributor Author

mingxin-zheng commented Jul 10, 2025

/build

@mingxin-zheng
Copy link
Contributor Author

mingxin-zheng commented Jul 10, 2025

/build

@mingxin-zheng
Copy link
Contributor Author

mingxin-zheng commented Jul 10, 2025

/build

@mingxin-zheng mingxin-zheng merged commit d34bf19 into main Jul 11, 2025
4 checks passed
@mingxin-zheng mingxin-zheng deleted the mz/fix_doc_1 branch July 11, 2025 02:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jjomier jjomier jjomier left review comments

@KumoLiu KumoLiu KumoLiu approved these changes

@Nic-Ma Nic-Ma Nic-Ma approved these changes

@wendell-hom wendell-hom Awaiting requested review from wendell-hom

@maximilianofir maximilianofir Awaiting requested review from maximilianofir

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mingxin-zheng @jjomier @Nic-Ma @KumoLiu