docs: move detailed setup notes into docs and simplify README#348
Open
plexoos wants to merge 1 commit into
Open
docs: move detailed setup notes into docs and simplify README#348plexoos wants to merge 1 commit into
plexoos wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the repository’s documentation by turning the root README.md into a concise landing page and moving detailed setup/usage/reference material into dedicated pages under docs/.
Changes:
- Simplified
README.mdto a short project overview + quick build + doc links. - Added focused documentation pages under
docs/for getting started, physics/inputs, and performance/debugging. - Updated links/badges and clarified build vs. runtime requirements placement.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Converts the root README into a lightweight entry point with badges, quick start, and links into docs/. |
| docs/README.md | Adds a documentation index page linking to the new guides. |
| docs/getting-started.md | Introduces prerequisites, build steps, container workflows, and an NERSC batch-job example. |
| docs/physics-and-inputs.md | Extracts and organizes Geant4 optical surface notes, torch config, and GDML input requirements. |
| docs/performance-and-debugging.md | Extracts and organizes performance-study workflow and photon_history_summary.py usage notes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Path to your image on Perlmutter | ||
| IMAGE="docker:bnlnpps/simphony:develop" | ||
| CMD='cd /src/simphony && simg4ox -g $OPTICKS_HOME/tests/geom/sphere_leak.gdml -m $OPTICKS_HOME/tests/run.mac -c sphere_leak' |
Member
Author
There was a problem hiding this comment.
should be defined in a config file
plexoos
force-pushed
the
improve-readme
branch
2 times, most recently
from
65488a3 to
2688143
Compare
This refactors the top-level README into a lighter project landing page and moves detailed setup and usage material into `docs/`. - simplify the root `README.md` - add focused documentation pages under `docs/` - fix and update README links and badges - clarify build vs runtime requirements
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
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.
This refactors the top-level README into a lighter project landing page and moves detailed setup and
usage material into
docs/.README.mddocs/