Skip to content

Conversation

@JoschD
Copy link
Member

@JoschD JoschD commented Jun 17, 2025

Move some stuff around, that still needs to be finished, but the main sites to review are (in that order):

docs/guis/betabeat

  • gui
  • defaults
  • beam_selection
  • common_components
  • settings

And for Admin:

  • docs/guis/usage/guidelines.md
  • docs/packages/development/managing.md

The rest should be just pictures and light touches.

@JoschD JoschD requested a review from fsoubelet June 17, 2025 12:15
@JoschD JoschD self-assigned this Jun 17, 2025
@JoschD JoschD added Type: Documentation Improvements, updates and fixes to the documentation. Priority: Low Work on this if you have some spare time. labels Jun 17, 2025
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 and all, appreciate the investment!

@fsoubelet
Copy link
Member

Also, I'm curious to see what Copilot might say so I'll summon it

@fsoubelet fsoubelet requested a review from Copilot June 17, 2025 14:19
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 reorganizes and updates the BBGUI documentation along with some Admin guides. Key changes include updating the mkdocs navigation structure, adding new GUI sections (Segment-by-Segment, RDT Feeddown, etc.), and introducing guidelines for GUI development and repository management.

Reviewed Changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
mkdocs.yml Updated navigation entries and key_map modification
docs/packages/omc3/analysis.md Added amplitude detuning analysis section
docs/packages/development/managing.md Added a comprehensive guide to repository management
docs/guis/usage/guidelines.md Introduced guidelines for GUI development
docs/guis/segment_by_segment/gui.md New page for the Segment-by-Segment GUI
docs/guis/rdt_feeddown/gui.md New page for the RDT Feeddown GUI
docs/guis/betabeat/* Updated pages documenting various GUI components
docs/css/custom_colors.css Added new CSS classes for UI enhancements

@JoschD JoschD requested a review from fsoubelet June 18, 2025 09:51
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.

I'm happy to merge as is in the feature branch. Left just a few unresolved conversations here to help my memory on things I said I'd do.

@JoschD JoschD merged commit 17b45c5 into user_guide_updates Jun 18, 2025
2 checks passed
@fsoubelet fsoubelet deleted the user_guide_updates_bbgui branch June 25, 2025 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Low Work on this if you have some spare time. Type: Documentation Improvements, updates and fixes to the documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants