Improve documentation - #651
Open
jank324 wants to merge 41 commits into
Open
Conversation
jank324
marked this pull request as draft
July 6, 2026 08:42
… conversion, plotting, and control integration
… beam importing section
…ntegrate with GPU/precision info
jank324
marked this pull request as ready for review
July 17, 2026 15:05
Hespe
reviewed
Jul 20, 2026
Co-authored-by: Christian Hespe <christian.hespe@desy.de>
…ml/cheetah into docs-structure-improvement
cr-xu
reviewed
Jul 20, 2026
Member
There was a problem hiding this comment.
Looks good to me in general.
Some minor comments:
- The flat-layout now in the left navigation panel will be overcrowded eventually. Shall we think of smaller subsections dividing by topics? (Getting Started / Physics / Optimizing Simulaiton / Auxiliary) The "API Reference" definitely makes more sense than before.
- Also now the ordering is a bit arbitrary, is it supposed to be sequentially from intro -> deep, it's pretty vague.
If we decide to keep the flat layout, I suggest adding some tags to the page so that later it becomes more findable?
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.
Description
Cleanup the structure of and extend the documentation to make getting started with Cheetah and discovering all of the things it can do easier.
Motivation and Context
Types of changes
Checklist
flake8(required).pytesttests pass (required).pyteston a machine with a CUDA GPU and made sure all tests pass (required).Note: We are using a maximum length of 88 characters per line.