diff options
author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2021-06-21 19:53:25 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-06-21 22:53:25 -0400 |
commit | f1e2789b262fa852ba43fad63088f356c2b08a88 (patch) | |
tree | dcc04d8a718f5d2bcb211c0f0b2c71c282f803ab | |
parent | b89990db9a4b9b4571e1460a938cc4101589a7e1 (diff) |
docs: Switch to webp, fix some sections (#514)
Switches to webp and fixes some typos/poor wording.
61 files changed, 31 insertions, 27 deletions
diff --git a/docs/content/assets/screenshots/basic.png b/docs/content/assets/screenshots/basic.png Binary files differdeleted file mode 100644 index a126bddb..00000000 --- a/docs/content/assets/screenshots/basic.png +++ /dev/null diff --git a/docs/content/assets/screenshots/basic.webp b/docs/content/assets/screenshots/basic.webp Binary files differnew file mode 100644 index 00000000..e7d1a8fd --- /dev/null +++ b/docs/content/assets/screenshots/basic.webp diff --git a/docs/content/assets/screenshots/battery.png b/docs/content/assets/screenshots/battery.png Binary files differdeleted file mode 100644 index 08c6dd96..00000000 --- a/docs/content/assets/screenshots/battery.png +++ /dev/null diff --git a/docs/content/assets/screenshots/battery.webp b/docs/content/assets/screenshots/battery.webp Binary files differnew file mode 100644 index 00000000..912f05c5 --- /dev/null +++ b/docs/content/assets/screenshots/battery.webp diff --git a/docs/content/assets/screenshots/config/disk-filtering/disk_name_filter.png b/docs/content/assets/screenshots/config/disk-filtering/disk_name_filter.png Binary files differdeleted file mode 100644 index 737aabca..00000000 --- a/docs/content/assets/screenshots/config/disk-filtering/disk_name_filter.png +++ /dev/null diff --git a/docs/content/assets/screenshots/config/disk-filtering/disk_name_filter.webp b/docs/content/assets/screenshots/config/disk-filtering/disk_name_filter.webp Binary files differnew file mode 100644 index 00000000..3a07ca11 --- /dev/null +++ b/docs/content/assets/screenshots/config/disk-filtering/disk_name_filter.webp diff --git a/docs/content/assets/screenshots/config/disk-filtering/disk_name_mount_filter.png b/docs/content/assets/screenshots/config/disk-filtering/disk_name_mount_filter.png Binary files differdeleted file mode 100644 index 943a7075..00000000 --- a/docs/content/assets/screenshots/config/disk-filtering/disk_name_mount_filter.png +++ /dev/null diff --git a/docs/content/assets/screenshots/config/disk-filtering/disk_name_mount_filter.webp b/docs/content/assets/screenshots/config/disk-filtering/disk_name_mount_filter.webp Binary files differnew file mode 100644 index 00000000..2a8373ad --- /dev/null +++ b/docs/content/assets/screenshots/config/disk-filtering/disk_name_mount_filter.webp diff --git a/docs/content/assets/screenshots/config/disk-filtering/disk_no_filter.png b/docs/content/assets/screenshots/config/disk-filtering/disk_no_filter.png Binary files differdeleted file mode 100644 index cf41c2f4..00000000 --- a/docs/content/assets/screenshots/config/disk-filtering/disk_no_filter.png +++ /dev/null diff --git a/docs/content/assets/screenshots/config/disk-filtering/disk_no_filter.webp b/docs/content/assets/screenshots/config/disk-filtering/disk_no_filter.webp Binary files differnew file mode 100644 index 00000000..44075f88 --- /dev/null +++ b/docs/content/assets/screenshots/config/disk-filtering/disk_no_filter.webp diff --git a/docs/content/assets/screenshots/config/layout/sample_layout.png b/docs/content/assets/screenshots/config/layout/sample_layout.png Binary files differdeleted file mode 100644 index 858ade7c..00000000 --- a/docs/content/assets/screenshots/config/layout/sample_layout.png +++ /dev/null diff --git a/docs/content/assets/screenshots/config/layout/sample_layout.webp b/docs/content/assets/screenshots/config/layout/sample_layout.webp Binary files differnew file mode 100644 index 00000000..da17d707 --- /dev/null +++ b/docs/content/assets/screenshots/config/layout/sample_layout.webp diff --git a/docs/content/assets/screenshots/cpu.png b/docs/content/assets/screenshots/cpu.png Binary files differdeleted file mode 100644 index d8b66392..00000000 --- a/docs/content/assets/screenshots/cpu.png +++ /dev/null diff --git a/docs/content/assets/screenshots/cpu.webp b/docs/content/assets/screenshots/cpu.webp Binary files differnew file mode 100644 index 00000000..e386f084 --- /dev/null +++ b/docs/content/assets/screenshots/cpu.webp diff --git a/docs/content/assets/screenshots/disk.png b/docs/content/assets/screenshots/disk.png Binary files differdeleted file mode 100644 index e635dc10..00000000 --- a/docs/content/assets/screenshots/disk.png +++ /dev/null diff --git a/docs/content/assets/screenshots/disk.webp b/docs/content/assets/screenshots/disk.webp Binary files differnew file mode 100644 index 00000000..3839b1cc --- /dev/null +++ b/docs/content/assets/screenshots/disk.webp diff --git a/docs/content/assets/screenshots/memory.png b/docs/content/assets/screenshots/memory.png Binary files differdeleted file mode 100644 index c48e525b..00000000 --- a/docs/content/assets/screenshots/memory.png +++ /dev/null diff --git a/docs/content/assets/screenshots/memory.webp b/docs/content/assets/screenshots/memory.webp Binary files differnew file mode 100644 index 00000000..f463654b --- /dev/null +++ b/docs/content/assets/screenshots/memory.webp diff --git a/docs/content/assets/screenshots/network/network.png b/docs/content/assets/screenshots/network/network.png Binary files differdeleted file mode 100644 index c424fa99..00000000 --- a/docs/content/assets/screenshots/network/network.png +++ /dev/null diff --git a/docs/content/assets/screenshots/network/network.webp b/docs/content/assets/screenshots/network/network.webp Binary files differnew file mode 100644 index 00000000..df932ff5 --- /dev/null +++ b/docs/content/assets/screenshots/network/network.webp diff --git a/docs/content/assets/screenshots/network/network_old.png b/docs/content/assets/screenshots/network/network_old.png Binary files differdeleted file mode 100644 index fdcc75e4..00000000 --- a/docs/content/assets/screenshots/network/network_old.png +++ /dev/null diff --git a/docs/content/assets/screenshots/network/network_old.webp b/docs/content/assets/screenshots/network/network_old.webp Binary files differnew file mode 100644 index 00000000..e56ce56c --- /dev/null +++ b/docs/content/assets/screenshots/network/network_old.webp diff --git a/docs/content/assets/screenshots/process/process_default.png b/docs/content/assets/screenshots/process/process_default.png Binary files differdeleted file mode 100644 index f1ae4587..00000000 --- a/docs/content/assets/screenshots/process/process_default.png +++ /dev/null diff --git a/docs/content/assets/screenshots/process/process_default.webp b/docs/content/assets/screenshots/process/process_default.webp Binary files differnew file mode 100644 index 00000000..3f429f8e --- /dev/null +++ b/docs/content/assets/screenshots/process/process_default.webp diff --git a/docs/content/assets/screenshots/process/process_full.png b/docs/content/assets/screenshots/process/process_full.png Binary files differdeleted file mode 100644 index e8aaefbb..00000000 --- a/docs/content/assets/screenshots/process/process_full.png +++ /dev/null diff --git a/docs/content/assets/screenshots/process/process_full.webp b/docs/content/assets/screenshots/process/process_full.webp Binary files differnew file mode 100644 index 00000000..8e7fc9ee --- /dev/null +++ b/docs/content/assets/screenshots/process/process_full.webp diff --git a/docs/content/assets/screenshots/process/process_grouped.png b/docs/content/assets/screenshots/process/process_grouped.png Binary files differdeleted file mode 100644 index 861514c1..00000000 --- a/docs/content/assets/screenshots/process/process_grouped.png +++ /dev/null diff --git a/docs/content/assets/screenshots/process/process_grouped.webp b/docs/content/assets/screenshots/process/process_grouped.webp Binary files differnew file mode 100644 index 00000000..a5fc6e85 --- /dev/null +++ b/docs/content/assets/screenshots/process/process_grouped.webp diff --git a/docs/content/assets/screenshots/process/process_sort_menu.png b/docs/content/assets/screenshots/process/process_sort_menu.png Binary files differdeleted file mode 100644 index 3feb3c77..00000000 --- a/docs/content/assets/screenshots/process/process_sort_menu.png +++ /dev/null diff --git a/docs/content/assets/screenshots/process/process_sort_menu.webp b/docs/content/assets/screenshots/process/process_sort_menu.webp Binary files differnew file mode 100644 index 00000000..cbde81ce --- /dev/null +++ b/docs/content/assets/screenshots/process/process_sort_menu.webp diff --git a/docs/content/assets/screenshots/process/process_tree.png b/docs/content/assets/screenshots/process/process_tree.png Binary files differdeleted file mode 100644 index ff7d8814..00000000 --- a/docs/content/assets/screenshots/process/process_tree.png +++ /dev/null diff --git a/docs/content/assets/screenshots/process/process_tree.webp b/docs/content/assets/screenshots/process/process_tree.webp Binary files differnew file mode 100644 index 00000000..a264df55 --- /dev/null +++ b/docs/content/assets/screenshots/process/process_tree.webp diff --git a/docs/content/assets/screenshots/process/search/cpu.png b/docs/content/assets/screenshots/process/search/cpu.png Binary files differdeleted file mode 100644 index b2bd6f26..00000000 --- a/docs/content/assets/screenshots/process/search/cpu.png +++ /dev/null diff --git a/docs/content/assets/screenshots/process/search/cpu.webp b/docs/content/assets/screenshots/process/search/cpu.webp Binary files differnew file mode 100644 index 00000000..53237ff0 --- /dev/null +++ b/docs/content/assets/screenshots/process/search/cpu.webp diff --git a/docs/content/assets/screenshots/process/search/or.png b/docs/content/assets/screenshots/process/search/or.png Binary files differdeleted file mode 100644 index 54c2821a..00000000 --- a/docs/content/assets/screenshots/process/search/or.png +++ /dev/null diff --git a/docs/content/assets/screenshots/process/search/or.webp b/docs/content/assets/screenshots/process/search/or.webp Binary files differnew file mode 100644 index 00000000..378fde7d --- /dev/null +++ b/docs/content/assets/screenshots/process/search/or.webp diff --git a/docs/content/assets/screenshots/process/search/quotes.png b/docs/content/assets/screenshots/process/search/quotes.png Binary files differdeleted file mode 100644 index b18277a7..00000000 --- a/docs/content/assets/screenshots/process/search/quotes.png +++ /dev/null diff --git a/docs/content/assets/screenshots/process/search/quotes.webp b/docs/content/assets/screenshots/process/search/quotes.webp Binary files differnew file mode 100644 index 00000000..c39daea4 --- /dev/null +++ b/docs/content/assets/screenshots/process/search/quotes.webp diff --git a/docs/content/assets/screenshots/process/search/regex.png b/docs/content/assets/screenshots/process/search/regex.png Binary files differdeleted file mode 100644 index ea41c1bb..00000000 --- a/docs/content/assets/screenshots/process/search/regex.png +++ /dev/null diff --git a/docs/content/assets/screenshots/process/search/regex.webp b/docs/content/assets/screenshots/process/search/regex.webp Binary files differnew file mode 100644 index 00000000..b970123e --- /dev/null +++ b/docs/content/assets/screenshots/process/search/regex.webp diff --git a/docs/content/assets/screenshots/process/search/search.png b/docs/content/assets/screenshots/process/search/search.png Binary files differdeleted file mode 100644 index 56d6be75..00000000 --- a/docs/content/assets/screenshots/process/search/search.png +++ /dev/null diff --git a/docs/content/assets/screenshots/process/search/search.webp b/docs/content/assets/screenshots/process/search/search.webp Binary files differnew file mode 100644 index 00000000..5bdeaf37 --- /dev/null +++ b/docs/content/assets/screenshots/process/search/search.webp diff --git a/docs/content/assets/screenshots/temperature.png b/docs/content/assets/screenshots/temperature.png Binary files differdeleted file mode 100644 index 6969792c..00000000 --- a/docs/content/assets/screenshots/temperature.png +++ /dev/null diff --git a/docs/content/assets/screenshots/temperature.webp b/docs/content/assets/screenshots/temperature.webp Binary files differnew file mode 100644 index 00000000..57ea2c86 --- /dev/null +++ b/docs/content/assets/screenshots/temperature.webp diff --git a/docs/content/assets/screenshots/troubleshooting/dots.png b/docs/content/assets/screenshots/troubleshooting/dots.png Binary files differdeleted file mode 100644 index f651fd33..00000000 --- a/docs/content/assets/screenshots/troubleshooting/dots.png +++ /dev/null diff --git a/docs/content/assets/screenshots/troubleshooting/dots.webp b/docs/content/assets/screenshots/troubleshooting/dots.webp Binary files differnew file mode 100644 index 00000000..1f654a54 --- /dev/null +++ b/docs/content/assets/screenshots/troubleshooting/dots.webp diff --git a/docs/content/assets/screenshots/troubleshooting/no_braille.png b/docs/content/assets/screenshots/troubleshooting/no_braille.png Binary files differdeleted file mode 100644 index 7d655467..00000000 --- a/docs/content/assets/screenshots/troubleshooting/no_braille.png +++ /dev/null diff --git a/docs/content/assets/screenshots/troubleshooting/no_braille.webp b/docs/content/assets/screenshots/troubleshooting/no_braille.webp Binary files differnew file mode 100644 index 00000000..60484f59 --- /dev/null +++ b/docs/content/assets/screenshots/troubleshooting/no_braille.webp diff --git a/docs/content/assets/screenshots/troubleshooting/weird_braille.png b/docs/content/assets/screenshots/troubleshooting/weird_braille.png Binary files differdeleted file mode 100644 index 95ddeb06..00000000 --- a/docs/content/assets/screenshots/troubleshooting/weird_braille.png +++ /dev/null diff --git a/docs/content/assets/screenshots/troubleshooting/weird_braille.webp b/docs/content/assets/screenshots/troubleshooting/weird_braille.webp Binary files differnew file mode 100644 index 00000000..cb36d39c --- /dev/null +++ b/docs/content/assets/screenshots/troubleshooting/weird_braille.webp diff --git a/docs/content/configuration/config-file/data-filtering.md b/docs/content/configuration/config-file/data-filtering.md index 0bbc7b45..ae7ea30e 100644 --- a/docs/content/configuration/config-file/data-filtering.md +++ b/docs/content/configuration/config-file/data-filtering.md @@ -8,7 +8,7 @@ You can hide specific disks, temperature sensors, and networks by name in the co For example, here's the disk widget with no filter: -![Disk no filter](/assets/config/disk-filtering/disk_no_filter.png) +![Disk no filter](/assets/screenshots/config/disk-filtering/disk_no_filter.webp) The following in the config file would filter out some entries by disk name: @@ -21,9 +21,9 @@ case_sensitive = false whole_word = false ``` -![Disk widget with just disk name filter](/assets/screenshots/config/disk-filtering/disk_name_filter.png) +![Disk widget with just disk name filter](/assets/screenshots/config/disk-filtering/disk_name_filter.webp) -If there are two potentially conflicting filters (i.e. when you are using both a disk and mount filter), the filter that explicitly allows an entry takes precedence over a filter that explicitly denies one. So for example, let's say I set a disk filter accepting anything with `/dev/sda`, but deny anything with `/mnt/.*` or `/`. So to do so, I write in the config file: +If there are two potentially conflicting filters (i.e. when you are using both a disk and mount filter), the filter that explicitly allows an entry takes precedence over a filter that explicitly denies one. So for example, let's say we set a disk filter accepting anything with `/dev/sda`, but deny anything with `/mnt/.*` or `/`. So to do so, we write in the config file: ```toml [disk_filter] @@ -41,6 +41,6 @@ case_sensitive = false whole_word = true ``` -Which gives me: +This gives us: -![Disk widget with disk name and mount filter](/assets/screenshots/config/disk-filtering/disk_name_mount_filter.png) +![Disk widget with disk name and mount filter](/assets/screenshots/config/disk-filtering/disk_name_mount_filter.webp) diff --git a/docs/content/configuration/config-file/layout.md b/docs/content/configuration/config-file/layout.md index fb32c5fe..f33b2126 100644 --- a/docs/content/configuration/config-file/layout.md +++ b/docs/content/configuration/config-file/layout.md @@ -31,7 +31,7 @@ The second column is split into two rows with a 1:1 ratio. The first is the temp This is what the layout would look like when run: -![Sample layout](/assets/screenshots/config/layout/sample_layout.png) +![Sample layout](/assets/screenshots/config/layout/sample_layout.webp) Each `[[row]]` represents a _row_ in the layout. A row can have any number of `child` values. Each `[[row.child]]` represents either a _column or a widget_. A column can have any number of `child` values as well. Each `[[row.child.child]]` diff --git a/docs/content/troubleshooting.md b/docs/content/troubleshooting.md index 28b5324d..4a1f04dc 100644 --- a/docs/content/troubleshooting.md +++ b/docs/content/troubleshooting.md @@ -7,14 +7,14 @@ It's possible that your graphs won't look great out of the box due to the relian One example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to render braille fonts. <figure> - <img src="../assets/screenshots/troubleshooting/no_braille.png" alt="Example of a terminal with no braille font."/> + <img src="../assets/screenshots/troubleshooting/no_braille.webp" alt="Example of a terminal with no braille font."/> <figcaption>Powershell shown missing braille fonts</figcaption> </figure> Another example is when braille is rendered as a block of dots, with the non-coloured dots also appearing. This may look strange for some users, and it is also caused by misconfiguration or missing fonts. <figure> - <img src="../assets/screenshots/troubleshooting/weird_braille.png" alt="Example of a terminal with the wrong braille font."/> + <img src="../assets/screenshots/troubleshooting/weird_braille.webp" alt="Example of a terminal with the wrong braille font."/> <figcaption>Braille fonts rendering as a block of dots</figcaption> </figure> @@ -24,7 +24,7 @@ and ensuring your terminal uses should work. Another alternative is to use the `--dot_marker` option to instead render graph charts using dots, which I've generally found to be better supported out of the box: <figure> - <img src="../assets/screenshots/troubleshooting/dots.png" alt="Example of running bottom with the dot marker flag"/> + <img src="../assets/screenshots/troubleshooting/dots.webp" alt="Example of running bottom with the dot marker flag"/> <figcaption>Example using <code>btm --dot_marker</code></figcaption> </figure> diff --git a/docs/content/usage/basic-mode.md b/docs/content/usage/basic-mode.md index 7913fbed..ff631d12 100644 --- a/docs/content/usage/basic-mode.md +++ b/docs/content/usage/basic-mode.md @@ -3,7 +3,7 @@ Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a very stripped-down version of) htop. <figure> - <img src="../../assets/screenshots/basic.png" alt="A picture of bottom's basic mode."/> + <img src="../../assets/screenshots/basic.webp" alt="A picture of bottom's basic mode."/> </figure> Basic mode can be enabled either through a command line flag: diff --git a/docs/content/usage/widgets/battery.md b/docs/content/usage/widgets/battery.md index 90fa7503..c1e62a75 100644 --- a/docs/content/usage/widgets/battery.md +++ b/docs/content/usage/widgets/battery.md @@ -3,7 +3,7 @@ The battery widget provides information about batteries on the system. <figure> - <img src="../../../assets/screenshots/battery.png" alt="A picture of an expanded battery widget."/> + <img src="../../../assets/screenshots/battery.webp" alt="A picture of an expanded battery widget."/> </figure> The battery widget can be enabled through either the `--battery` flag, the `battery = true` option in a config file, or specifying the widget in a custom layout. diff --git a/docs/content/usage/widgets/cpu.md b/docs/content/usage/widgets/cpu.md index 1c59376b..11e0cb0f 100644 --- a/docs/content/usage/widgets/cpu.md +++ b/docs/content/usage/widgets/cpu.md @@ -3,7 +3,7 @@ The CPU widget displays a visual representation of CPU usage over a time range. <figure> - <img src="../../../assets/screenshots/cpu.png" alt="A picture of an expanded CPU widget showing average CPU usage."/> + <img src="../../../assets/screenshots/cpu.webp" alt="A picture of an expanded CPU widget showing average CPU usage."/> </figure> ## Features diff --git a/docs/content/usage/widgets/disk.md b/docs/content/usage/widgets/disk.md index 655f0357..7288b36a 100644 --- a/docs/content/usage/widgets/disk.md +++ b/docs/content/usage/widgets/disk.md @@ -3,7 +3,7 @@ The disk widget provides a table of useful disk and partition information, like I/O per second and total usage. <figure> - <img src="../../../assets/screenshots/disk.png" alt="A picture of an expanded disk widget."/> + <img src="../../../assets/screenshots/disk.webp" alt="A picture of an expanded disk widget."/> </figure> ## Features diff --git a/docs/content/usage/widgets/memory.md b/docs/content/usage/widgets/memory.md index 180b4b64..f92f18a8 100644 --- a/docs/content/usage/widgets/memory.md +++ b/docs/content/usage/widgets/memory.md @@ -3,7 +3,7 @@ The memory widget provides a visual representation of RAM and swap usage over time. <figure> - <img src="../../../assets/screenshots/memory.png" alt="A picture of an expanded memory widget."/> + <img src="../../../assets/screenshots/memory.webp" alt="A picture of an expanded memory widget."/> </figure> ## Features diff --git a/docs/content/usage/widgets/network.md b/docs/content/usage/widgets/network.md index 8e58194c..e0fc5b56 100644 --- a/docs/content/usage/widgets/network.md +++ b/docs/content/usage/widgets/network.md @@ -4,12 +4,16 @@ The network widget provides a visual representation of network input and output received and transmitted. <figure> - <img src="../../../assets/screenshots/network/network.png" alt="A picture of an expanded network widget."/> + <img src="../../../assets/screenshots/network/network.webp" alt="A picture of an expanded network widget."/> </figure> ## Features -The legend displays the current reads and writes per second, as well as the total amount read/written. +The legend displays the current reads and writes per second in bits, as well as the total amount read/written. + +The y-axis automatically scales based on shown read/write values, and by default, is a linear scale based on base-10 units (e.x. kilobit, gigabit, etc.). +Through [configuration](../../../configuration/command-line-flags/), the read/write per second unit can be changed to bytes, while the y-axis can be changed to a +log scale and/or use base-2 units (e.x. kibibit, gibibit, etc.). One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s. |