Skip to content

Conversation

@kmichalikk
Copy link
Contributor

This PR prepares the user docs to contain separate steps for each simulator. Additionally, it mentiones Geant4 as a simulator available in Demo Mode, and adds some mkdocs extensions for more rich user documentation.

With the extension, we are able to render better-looking Admonitions:
image

Example of a tabbed part of the doc:
image

For now, other simulators are "Under development":
image

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the user documentation by restructuring it to provide simulator-specific instructions for SHIELD-HIT12A, FLUKA, and Geant4. It also upgrades the documentation framework by adding MkDocs extensions for better presentation.

  • Adds markdown extensions (admonition, pymdownx.details, pymdownx.superfences, pymdownx.tabbed) for richer documentation formatting
  • Restructures tutorial content into tabbed sections for each simulator
  • Updates references to include Geant4 as available in Demo Mode

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
mkdocs.yml Adds markdown extensions for admonitions, details, superfences, and tabbed content
docs/index.md Updates platform description to mention all three simulators and clarifies Demo Mode capabilities
docs/geometry.md Converts existing geometry tutorial into tabbed format with simulator-specific sections
docs/settings.md Restructures beam and physics settings documentation with tabs for different simulators
docs/scoring.md Organizes scoring instructions into simulator-specific tabs with improved formatting
docs/running.md Reorganizes simulation running instructions with tabs and info admonitions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@grzanka grzanka merged commit 935a65c into main Nov 16, 2025
4 checks passed
@grzanka grzanka deleted the @kmichalikk/docs-many-sim-prep branch November 16, 2025 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants