Docs: Improve documentation and enhance Trial story UX #1450
Conversation
This file contains 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
…don't seem to show up)
… click in the component, which is kind of counter intuitive, bad ux)
26 tasks
BeritJanssen
reviewed
Jan 6, 2025
There was a problem hiding this comment.
Indeed, styles is something to be revisited. I see two approaches now:
- a dictionary with multiple
'class-name': Truecombinations, which essentially means these classes will be slapped onto the class list of the corresponding frontend component's element. This is used in the Categorization rules. - a single string, which is evaluated by
FrontendStyleagainst a number of possible values.
I like the first approach better, as it's less involved. However, I also struggle with how to document the possible class names that could be set from the backend, and their effect on the frontend styling. It would be good that, if a user sets the class name to neurtal, the backend raises a warning to catch the typo.
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.
Add docstrings for style constants in
styles.pyfor better clarity. These don't seem to show up in mkdocs though... Maybe because they aren't classes/functions?Fix the initial display issue of the Trial story to improve user experience by ensuring it shows correctly without requiring a click.
Related to #1428