docs: add admonitions (#882)

MarcoIeni · Aug 1, 2023 · d5f5950 · d5f5950
1 parent 75cf6f4
commit d5f5950
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/website/docs/config.md b/website/docs/config.md
@@ -93,8 +93,10 @@ semver_check = false
   The uncommitted changes will be part of the update.
 - If `false`, release-plz returns an error if the repository contains uncommitted changes. *(Default)*.
 
-Note: This field is different from the `allow-dirty` flag of the `release-plz release` command.
+:::caution
+This field is different from the `allow-dirty` flag of the `release-plz release` command.
 This field only affects the `release-plz update` and `release-plz release-pr` command.
+:::
 
 #### The `changelog_config` field
 

diff --git a/website/docs/extra/releasing-binaries.md b/website/docs/extra/releasing-binaries.md
@@ -110,5 +110,7 @@ Some projects to consider for this task:
 - [cargo-dist](https://crates.io/crates/cargo-dist):
   shippable application packaging for Rust.
 
-Note: to release a binary after release, the release-plz GitHub Action needs to
+:::caution
+To release a binary after release, the release-plz GitHub Action needs to
 [trigger further workflow runs](../github/trigger.md).
+:::
diff --git a/website/docs/usage/shell-completion.md b/website/docs/usage/shell-completion.md
@@ -34,7 +34,9 @@ To load completions for every new session, execute once:
 release-plz generate-completions bash > ~/.local/share/bash-completion/completions/release-plz
 ```
 
-Note: package `bash-completion` is required for this to work.
+:::caution
+The package `bash-completion` is required for this to work.
+:::
 
 ## fish