CAD tutorial : MkDocs sources plus an ITS round-trip example - #15790
Merged
Merged
Conversation
This converts the single-page tutorial to Markdown, adds a worked example on the ITS and updates the README pointer. - doc/tutorial/index.html is replaced by a MkDocs project: mkdocs.yml, one page per section under docs/, and the figures as files in docs/images/. - The pages use GitHub's own alert and fence syntax, so they render in the repository file view without a published site. - hooks/github_alerts.py turns those alerts into Material admonitions at build time, so the site needs only mkdocs-material. - docs/its-round-trip.md is new: the ITS through o2-tgeo-to-cad and back, then placed as a sensitive external detector to produce hits. - The tutorial pointer in README.md now names the directory. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017gNpas1pZ9DNBhVesoM5QZ
sawenzel
changed the title
sawenzel
added a commit
to AliceO2Group/simulation
that referenced
this pull request
Sep 12, 2026
This adds a new documentation section, CAD simulation tutorial, and the job that keeps it in step with its sources. - docs/cadtutorial holds the section. It is generated, not edited here. - The sources live in AliceO2, Detectors/CADSupport/doc/tutorial, next to the converter they document. - .github/scripts/sync_cad_tutorial.py converts them: GitHub alerts become the theme's note and warning fences, and each page gets its front matter. - .github/workflows/cad-tutorial-sync.yml runs it weekly and on demand, and commits when the result changes. AliceO2Group/AliceO2#15790 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017gNpas1pZ9DNBhVesoM5QZ
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 PR extends the CAD simulation tutorial and refactors a bit.