Refactoring of the robotic surgery documentation to break out subfolders into focused READMEs #185
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
A refactoring of the robotic surgery documentation to break out subfolders into focused READMEs, simplify navigation, and enhance clarity with a technical overview and quick start.
- Introduces dedicated
README.mdfiles for Reinforcement Learning and State Machine environments. - Simplifies the simulation folder index and updates Docker instructions.
- Overhauls the top-level workflow README with emojis, a quick-start guide, and structured setup details.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| workflows/robotic_surgery/scripts/simulation/scripts/reinforcement_learning/rsl_rl/README.md | New RL training and play instructions |
| workflows/robotic_surgery/scripts/simulation/scripts/environments/state_machine/README.md | New state-machine usage examples |
| workflows/robotic_surgery/scripts/simulation/README.md | Simplified simulation folder index |
| workflows/robotic_surgery/docker/README.md | Clarified interactive and headless Docker commands |
| workflows/robotic_surgery/README.md | Major restructure: tech overview, quick start, TOC |
Comments suppressed due to low confidence (3)
workflows/robotic_surgery/scripts/simulation/README.md:4
- [nitpick] Consider adding a brief description for each link to guide users—for example:
- [State Machine Environments](./scripts/environments/state_machine/README.md): examples of hand-crafted surgical state machines.
- [State Machine Environments](./scripts/environments/state_machine/README.md)
workflows/robotic_surgery/README.md:23
- The anchor link may not resolve correctly due to the leading hyphen. Update it to
(#running-workflows)or test the actual generated ID to ensure the TOC link works.
- [⚡ Running Workflows](#-running-workflows)
workflows/robotic_surgery/scripts/simulation/scripts/reinforcement_learning/rsl_rl/README.md:12
- The docs mention "playing with 50 environments" but the example command lacks a
--num-envsflag. Either clarify the default behavior or include the flag (e.g.,--num-envs 50) in the example.
# run script for playing with 50 environments
mingxin-zheng
changed the title
Signed-off-by: Mingxin Zheng <[email protected]>
Signed-off-by: Mingxin Zheng <[email protected]>
Signed-off-by: Mingxin Zheng <[email protected]>
Signed-off-by: Mingxin Zheng <[email protected]>
mingxin-zheng
force-pushed
the
mz/fix_doc_2
branch
from
6fbe84e to
5822eda
Compare
|
/build |
Signed-off-by: Mingxin Zheng <[email protected]>
|
/build |
Nic-Ma
approved these changes
Jul 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A refactoring of the robotic surgery documentation to break out subfolders into focused READMEs, simplify navigation, and enhance clarity with a technical overview and quick start.
Introduces dedicated README.md files for Reinforcement Learning and State Machine environments.
Simplifies the simulation folder index and updates Docker instructions.
Overhauls the top-level workflow README with emojis, a quick-start guide, and structured setup details.