Add simulator management documentation and update navigation#39
Merged
Add simulator management documentation and update navigation#39
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for managing SHIELD-HIT12A and FLUKA simulation engine binaries using S3 storage, and enhances the developer onboarding experience with improved quick start instructions for the documentation itself.
Changes:
- Added detailed simulator management guide covering S3-based storage, encryption, deployment workflows, and version management
- Updated navigation in mkdocs.yml and backend documentation index to include the new Simulator Management section
- Improved documentation quick start guide with clearer step-by-step instructions for setting up and serving the documentation locally
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| mkdocs.yml | Added "Simulator Management" entry to backend navigation menu |
| docs/documentation/index.md | Restructured quick start section with step-by-step recipe for cloning, installing dependencies, and serving documentation |
| docs/backend/simulator_management.md | New comprehensive guide covering S3 storage architecture, command reference, practical examples, and environment configuration for simulator binaries |
| docs/backend/index.md | Added link to new Simulator Management documentation in backend overview |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
1 participant
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 pull request adds comprehensive documentation for managing simulation engine binaries (SHIELD-HIT12A and FLUKA) using S3 storage, and improves the developer documentation with a clearer quick start guide. The main changes include the addition of a new simulator management guide, updates to documentation navigation, and enhancements to onboarding instructions.
Documentation improvements:
simulator_management.mdcovering how to store, deploy, encrypt, and manage versions of SHIELD-HIT12A and FLUKA simulation binaries using S3, including command-line usage, environment configuration, and practical examples.mkdocs.ymland the backend documentation index to include the new Simulator Management section in the navigation and documentation overview. [1] [2]Developer onboarding enhancements:
docs/documentation/index.md, providing a step-by-step recipe for cloning the repository, installing dependencies, serving, and building the documentation, making it easier for new contributors to get started.