Skip to content

Improve documentation - #651

Open
jank324 wants to merge 41 commits into
masterfrom
docs-structure-improvement
Open

Improve documentation#651
jank324 wants to merge 41 commits into
masterfrom
docs-structure-improvement

Conversation

@jank324

@jank324 jank324 commented Jul 3, 2026

Copy link
Copy Markdown
Member

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

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist

  • I have updated the changelog accordingly (required).
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.
  • I have reformatted the code and checked that formatting passes (required).
  • I have have fixed all issues found by flake8 (required).
  • I have ensured that all pytest tests pass (required).
  • I have run pytest on a machine with a CUDA GPU and made sure all tests pass (required).
  • I have checked that the documentation builds (required).

Note: We are using a maximum length of 88 characters per line.

@jank324
jank324 marked this pull request as draft July 6, 2026 08:42
@jank324 jank324 changed the title Improve documentation structure Improve documentation Jul 16, 2026
@jank324 jank324 added the documentation Improvements or additions to documentation label Jul 16, 2026
@jank324 jank324 self-assigned this Jul 16, 2026
@jank324
jank324 marked this pull request as ready for review July 17, 2026 15:05
@jank324
jank324 requested review from Hespe, Copilot and cr-xu July 17, 2026 15:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Comment thread docs/getting_started/coordinate_system.md
Comment thread docs/coordinate_system.md
Comment thread docs/getting_started/coordinate_system.md
Comment thread docs/getting_started/control_systems.md Outdated
Comment thread docs/getting_started/tracking_methods.md Outdated
Comment thread docs/getting_started/tracking_methods.md Outdated
@jank324
jank324 requested a review from Hespe July 20, 2026 11:33

@cr-xu cr-xu left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants