WIP redesign notes and admonitions#11641
Conversation
|
✔️ Deploy Preview for docsdocker ready! 🔨 Explore the source changes: fefd8e4 🔍 Inspect the deploy log: https://app.netlify.com/sites/docsdocker/deploys/60e559e104212e0008937f45 😎 Browse the preview: https://deploy-preview-11641--docsdocker.netlify.app |
79fc5b1 to
3a0f3fc
Compare
|
/cc @usha-mandya we can look at this one in our call later |
fcd9155 to
5cd787b
Compare
This brings the initial work to redesign our notes and admonitions.
The following adminitions are supported:
- info: generic note with "info" icon
- tip: note with a "lightbulb" icon
- check: note with a "check" icon
- important: note with an exclamation mark
- warning: note with an exclamation mark in a triangle
Things remaining:
- update the examples and descriptions in "test.md"
- tweak line-heights / typography
- review uses of "warning" versus "important"; their purpose needs to be
defined better (and styled accordingly)
- color-schemes: we can likely use the same colors for "dark" and "light"
mode. There's also some colors ("warning", e.g.) that use some tweaking.
- add classes to existing notes to switch between a "regular" note to
notes with an icon ("admonition").
- removing "note" as first line: when using an icon, the icon can replace
"note" in many cases; removing the "note" makes the note more compact
without loosing meaning, so we should remove those.
- for other notes, we should do the reverse: replace "note" with a more
suitable introduction. I updated some pages to illustrate this. Setting
a more descriptive first line can give notes a better context.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
5cd787b to
fefd8e4
Compare
|
Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions. If the updates are still relevant, review our contribution guidelines and rebase your pull request against the latest version of the docs, then mark it as fresh with a Prevent pull requests from auto-closing with a /lifecycle stale |
follow-up to #11640 (changes are in the last commit). It's still a WIP, but I had this branch lingering around on my machine as part of other changes, so I thought to push it as a PR to share.
This brings the initial work to redesign our notes and admonitions.
The following adminitions are supported:
info: generic note with "info" icontip: note with a "lightbulb" iconcheck: note with a "check" iconimportant: note with an exclamation markwarning: note with an exclamation mark in a triangleThere are some alternative icons that I considered (currently commented in the style-sheet, but to be removed)
Things remaining:
Examples
Here's some pages that could be used to view the updates styles:
Screenshots
And some screenshots