-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: enable tooltips #21324
docs: enable tooltips #21324
Conversation
Updates the theme to the latest version to enable tooltips and modifies the db_options.tmpl to show the new role in action.
Docs Preview 📖Docs Preview for this pull request is available here Changed Files: Note: This preview will be available for 30 days and will be automatically deleted after that period. You can manually trigger a new build by committing changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great.
@tzach Please have a look. |
I love the tooltip feature, but in this case (Liveness) the tip is too long, and hard to read. |
@tzach We're on the same page here. Tooltips that are too long are hard to follow, and we should avoid lengthy descriptions. This PR only demonstrates how the tooltip feature works — we need to adjust the tooltip content while using the feature. Regarding the bigger font, we need to see how it would work. Perhaps increasing spacing would do? |
@denesb Please merge. |
@@ -0,0 +1,1374 @@ | |||
# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this part of the commit or accidental?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's part of the commit (update to the latest version). We now include poetry.lock
in all projects (context).
Unless contributors manually run make update
, the poetry.lock
file will remain static and won’t be changed in other pull requests.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the future, consider doing this as a separate PR or at least as a separate commit, so it doesn't get lost in the noise.
Related issue #873
Updates the docs theme to the latest version to enable tooltips and modifies the
db_options.tmpl
to show the new role in action.How to test
Clone this PR.
Build the docs.
Open http://127.0.0.1:5500/reference/configuration-parameters/ and preview the tooltips: