Skip to content

Add multiturn documentation #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 66 commits into
base: user_guide_updates
Choose a base branch
from
Open

Conversation

jgray-19
Copy link
Contributor

A quick little bit of documentation. Likely needs some adjusting. Let me know if I missed anything!

@jgray-19 jgray-19 requested review from fsoubelet, JoschD and Copilot June 28, 2025 17:07
Copilot

This comment was marked as outdated.

@fsoubelet
Copy link
Member

Thanks! Something good came out of these beam dumps :) will have a look a bit later

Copy link
Member

@fsoubelet fsoubelet left a comment

Choose a reason for hiding this comment

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

Nitpicks, consistency and suggestions here and there. Thanks for the very good start.

If you're ok with it I am down to add commits on this branch and contribute, especially in places I have recommended adding some content.

@jgray-19
Copy link
Contributor Author

Nitpicks, consistency and suggestions here and there. Thanks for the very good start.

If you're ok with it I am down to add commits on this branch and contribute, especially in places I have recommended adding some content.

Feel free to make any change you like!

@jgray-19 jgray-19 requested review from fsoubelet and Copilot June 29, 2025 11:14
Copilot

This comment was marked as outdated.

@fsoubelet
Copy link
Member

fsoubelet commented Jul 1, 2025

Applied corrections. Two new TODOs:

  • Double check the convention for bunches selection (space separated or comma separated values?)
  • Double check the meaning of the Chroma State flags. Afaik we don't have a "chroma feedback" per se. @JoschD do you remembered? I've asked Ewen but haven't heard back yet.

@fsoubelet
Copy link
Member

Closes #191

@fsoubelet fsoubelet requested review from JoschD and Copilot July 1, 2025 13:52
@fsoubelet
Copy link
Member

Done with changes and TODOs. I think this is in a pretty good state.

Copy link

@Copilot 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 adds comprehensive Multiturn GUI documentation, updates the MkDocs configuration to surface these new pages in the navigation, and fixes several small doc inconsistencies and missing attributes.

  • Introduced detailed docs for Safety Checks, Beam Excitation, and AC Dipole Scheduler under docs/guis/multiturn/
  • Updated mkdocs.yml palette settings and navigation to include new Multiturn sections
  • Applied minor content fixes: added alt text, corrected typos, and updated link targets

Reviewed Changes

Copilot reviewed 13 out of 26 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
mkdocs.yml Added light/dark palette entries and new Multiturn nav
docs/packages/pylhcsubmitter/job_submitter.md Added missing alt text on image
docs/measurements/procedures/general_checks.md Added Multiturn tip, typo fix, new checklist item, updated external links
docs/logbook/LHC/2025_lhc.md Simplified LaTeX notation in coupling description
docs/logbook/LHC/2022_lhc.md Removed stale TODO comment
docs/guis/usage/ide_install.md Fixed leading phrase for VSCode installation instruction
docs/guis/multiturn/scheduler.md New AC Dipole Scheduler documentation
docs/guis/multiturn/safety.md New Safety Checks documentation
docs/guis/multiturn/gui.md Updated Multiturn GUI overview with new section links
docs/guis/multiturn/excitation.md New Beam Excitation guide
docs/guis/betabeat/optics_panel.md Corrected BBS file link target
docs/guis/about.md Added placeholder TODO in about page
docs/css/extra.css Refined comment on primary color utility
Comments suppressed due to low confidence (3)

mkdocs.yml:37

  • Indentation under the palette: section appears inconsistent with the rest of the YAML. Misaligned dashes or spaces can cause parsing errors; please align all entries to the existing indent level.
    - scheme: default

mkdocs.yml:196

  • The new navigation entries under 'Multiturn GUI' have an extra level of indentation compared to the 'About' entry above. Please align these for consistent nesting.
        - Safety Checks: guis/multiturn/safety.md

docs/measurements/procedures/general_checks.md:10

  • The relative link to guis/multiturn/gui.md is incorrect from within measurements/procedures. It needs one more .. (e.g., ../../../guis/multiturn/gui.md) or use an absolute site path to ensure the link resolves.
    [See here](../../guis/multiturn/gui.md) for a full section about this GUI and how to use it.

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.

3 participants