Merge Current User Guide #207
Merged
Conversation
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
* 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 <[email protected]>
--------- Co-authored-by: Felix Soubelet <[email protected]>
fsoubelet
added
Type: Documentation
fsoubelet
added
Estimate: Easy
Member
Author
|
Note to myself: update the required checks once this is merged and the "new version" of the workflows have been integrated into master. Can't click them now in the branch protection settings as they've only run on other branches. |
JoschD
approved these changes
Sep 9, 2025
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.
Simple merge of the
user_guide_updatesto be deployed so that the nice work done there can be enjoyed while we develop the last pages.All the content in this PR has been approved throught PRs to this branch already.
Requires #206 to be merged first.