Skip to content

Conversation

@JoschD
Copy link
Member

@JoschD JoschD commented Aug 27, 2025

Started collecting people.
Still needs some content.

JoschD and others added 26 commits May 15, 2025 18:37
* add image for kmod gui landing page

* rework Kmod main GUI page

* remove all previous kmod pages as they are vastly outdated

* remove outdated supporting images

* file rename

* pages for later

* and in the website layout too

* written circuit selection and settings for kmod, with supporting image

* end of modulating section

* no need for a page for retrieval, merge with analysis

* attempts uv in CI

* use uv in the deploy workflow too

* retrieving modulations

* analyzing modulations

* mention auto logging

* quick linting of rws procedure, add prab paper ref

* linting fixes

* simplify measurement procedure page for Kmod

* typo fix

* better suggestion
* need trailing line

* alt tag in images

* alt tag and spaces before code block

* center figure

* alt tag and lines in admonitions blocks

* trailing line

* empty lines and bullet lists linting

* empty lines

* empty lines

* empty lines

* trailing spaces

* trailing spaces

* fix todo

* empty lines

* define sshutle link

* no kmod special as OP develops it now

* remove from navigation too

* alt text and center figures

* trailing spaces

* multiple empty lines, trailing spaces and eol at eof fixes in all logbook files

* trailing spaces

* eol at eof

* trailing spaces

* eol at eof

* multiple empty lines, trailing spaces and eol at eof fixes

* do not include weirdass AI pictures in the website

* remove assets as well

* alt tag and center figure

* properly close center tag

* html for figure

* specify code fence language

* multiple empty lines, trailing spaces and eol at eof fixes

* multiple empty lines, trailing spaces and eol at eof fixes

* eol at eof

* eol at eof

* explicitely refer to felix carlier

* empty lines

* empty lines

* empty lines, alt tags and 2 spaces for highlighting

* alt tags and centered

* trailing spaces

* eol at eof

* trailing spaces

* fix relative link

* fix relative anchor links

* fix relative anchor links

* remove problematic anchor link

* fix link for new kmod app

* remove another broken anchor link

* fix broken rel link since files move by josch

* fix broken rel link since files move by josch

* fix broken rel link since files move by josch

* and refer to the proper tag

* include alt tag for each image entry and reformat table

* headers consistency and proper pip invocation command

* eol at eof

* spaces around code fences

* empty lines

* headers and list style

* strip end space in code fence

* spaces around code fences

* trailing spaces and empty lines around code fence blocks

* trailing spaces and headers consistency

* proper pip invocation

* and ref

* and from navigation

* eol at eof

* trailing spaces and empty lines around code fence blocks

* trailing spaces

* trailing spaces

* eol at eof and empty space around code block

* eol at eof and empty space around code block

* eol at eof and empty space around code block

* trailing spaces

* eol at eof

* trailing spaces and empty lines around code fence blocks

* empty lines

* trailing spaces, empty lines, deduplicate headers

* no punctuation in headers

* eol at eof

* little arrow last

* use headers as the numbered list would reset anyway

* remove trailing punctuation in header

* empty lines

* remove forgotten html artefact

* imports sorting

* imports sorting, quick formatting

* minor typing, import future annotations

* be explicit in what is replaced, via naming to avoid confusion. Type checker was complaining

* a little type hinting

* linting, formatting, eol at eof

* ruff formatting again

* future annotations

* types and ruff formatting

* escape pip

* proper pip invocation

* proper pip invocation
* decapole studies at injection is a 2023 note

* folder and page for chroma gui, first section

* added to naviation

* add default view on chroma gui, include figure

* extraction part, with supporting files

* new header

* set option to show copy button for code blocks:

* put bounds on requirements

* specify step size

* cleaning section done, with supporting files

* chromaticity section

* corrections section and supporting file, change a few admonition types

* add mention and links of chroma gui to main GUIs page

* we can afford some letters
Co-authored-by: Felix Soubelet <19598248+fsoubelet@users.noreply.github.com>
@JoschD JoschD added Type: Documentation Improvements, updates and fixes to the documentation. Priority: Medium Work on this. labels Aug 27, 2025
@JoschD JoschD added Status: In Progress Currently being worked on. Estimate: Normal Straightforward, but might require some time. Probably needs additional tests. labels Aug 27, 2025
Base automatically changed from user_guide_updates to master September 9, 2025 15:06
@JoschD JoschD marked this pull request as ready for review October 20, 2025 18:31
@JoschD
Copy link
Member Author

JoschD commented Oct 20, 2025

Hey, I added some informational text to most of the entries and additional resources for help/info.
Not sure if there is anything else needed. Some entries look a bit blank, but that's also the state of my brain with regards to ideas on what additional info to write there, so I am not sure if necessary. But feel free to add.

The only BIG thing missing, I think, is the person responsible for the AC-Dipole. But I forgot who that was. @emaclean ?

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.

Just some tidbits from me. I am ok with all this content but not the most knowledgeable, I think it'd be nice to wait for a review from @emaclean.

Copy link
Contributor

@jgray-19 jgray-19 left a comment

Choose a reason for hiding this comment

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

Just some general comments.

On another note, in dark mode, I am finding most of the hyperlinks look a little too dark, is there a way to make them look lighter? Perhaps not for this PR.

@JoschD JoschD requested review from fsoubelet and jgray-19 November 10, 2025 15:06
Copy link
Contributor

@jgray-19 jgray-19 left a comment

Choose a reason for hiding this comment

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

Looks all good to me!

@JoschD JoschD merged commit 48b7708 into master Nov 10, 2025
2 checks passed
@JoschD JoschD deleted the user_guide_updates_contacts branch November 10, 2025 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Estimate: Normal Straightforward, but might require some time. Probably needs additional tests. Priority: Medium Work on this. Status: In Progress Currently being worked on. Type: Documentation Improvements, updates and fixes to the documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants