Open
Conversation
LecrisUT
added
documentation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
happz
reviewed
Mar 6, 2026
thrix
approved these changes
Mar 13, 2026
Contributor
thrix
left a comment
thrix
left a comment
There was a problem hiding this comment.
LGTM, two minor things to address before merging:
- Missing trailing period on the "guest" definition (line 13) — "runner" has one, "guest" doesn't.
- Lexicographic ordering within concept groups as discussed with @happz.
Nothing else found.
Generated-by: Claude Code
Signed-off-by: Cristian Le <git@lecris.dev>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This serves as a place where we can dump all definitions of the terms that we use across the project. During the documentation, this can then be consumed with the
:term:role giving a reference link to the definition of the term. If we combine this with sphinx-tippy we get a nice pop-up with the contents.Currently the glossary is not meant to be alphabetically ordered to be able to group together similarly related terms. We should also be able to use multiple
.. glossaryand group them via sections if a meaningful separation is available