From 10f8874e382dcbf3401cf1f24005e2d04367f1eb Mon Sep 17 00:00:00 2001 From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> Date: Thu, 9 Jul 2026 18:30:59 -0400 Subject: [PATCH] docs: update docs with 0.14.4 (#2140) --- .github/ISSUE_TEMPLATE/bug_report.yml | 76 ++++++++++++++-------- .github/ISSUE_TEMPLATE/feature_request.yml | 20 ++++-- .github/ISSUE_TEMPLATE/packaging.yml | 40 ++++++++---- README.md | 24 +++---- 4 files changed, 101 insertions(+), 59 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 6d655e5b..bb92a81f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,7 @@ name: Bug report -description: Found something wrong or broken? If it hasn't already been filed/solved, report it! -labels: ["bug"] +description: Found something wrong or broken? If it hasn't already been + filed/solved, report it! +labels: [ "bug" ] body: - type: checkboxes id: acknowledgements @@ -8,20 +9,29 @@ body: label: Checklist options: - label: > - I've looked through the [troubleshooting docs](https://bottom.pages.dev/nightly/troubleshooting), - [the known problems list](https://bottom.pages.dev/nightly/support/official/#known-problems), and - [existing open issues](https://github.com/ClementTsang/bottom/issues?q=is%3Aopen+is%3Aissue) for similar - issues. + I've looked through the [troubleshooting + docs](https://bottom.pages.dev/nightly/troubleshooting), [the known + problems + list](https://bottom.pages.dev/nightly/support/official/#known-problems), + and [existing open + issues](https://github.com/ClementTsang/bottom/issues?q=is%3Aopen+is%3Aissue) + for similar issues. required: true + - label: > + I've read through the [AI + policy](https://github.com/ClementTsang/bottom/blob/main/AI_POLICY.md) + and am following it when reporting this bug. - type: input id: operating_system attributes: label: What operating system and version are you using? description: > - Please provide the operating system(s) and version(s) that are experiencing the problem. - Note that issues on operating systems that [are not officially supported](https://github.com/ClementTsang/bottom#support) - may not be prioritized/resolved. + Please provide the operating system(s) and version(s) that are + experiencing the problem. Note that issues on operating systems that + [are not officially + supported](https://github.com/ClementTsang/bottom#support) may not be + prioritized/resolved. placeholder: Arch Linux 6.6.2 - type: dropdown @@ -30,8 +40,9 @@ body: label: What architecture are you using? description: > Please select the architecture(s) that are experiencing the problem. - Note that systems that [are not officially supported](https://github.com/ClementTsang/bottom#support) - may not be prioritized/resolved. + Note that systems that [are not officially + supported](https://github.com/ClementTsang/bottom#support) may not be + prioritized/resolved. multiple: true options: - x86_64/AMD64 @@ -43,10 +54,12 @@ body: - type: textarea id: terminal attributes: - label: What terminal(s) are you running bottom on that are experiencing the problem? + label: What terminal(s) are you running bottom on that are experiencing the + problem? description: > - Please provide what terminal(s) you are running `bottom` on (e.g. Konsole, kitty, urxvt) - that are experiencing the issue, as well as their version and any relevant settings (e.g. terminal theme). + Please provide what terminal(s) you are running `bottom` on (e.g. + Konsole, kitty, urxvt) that are experiencing the issue, as well as their + version and any relevant settings (e.g. terminal theme). placeholder: kitty 0.25.2 - type: dropdown @@ -56,8 +69,9 @@ body: attributes: label: (Optional) What filesystem(s) are you using? description: > - If you know, please select what filesystem(s) you are using on the system that is experiencing the problem. This - can be especially helpful if the issue is related to either the disk or memory widgets. + If you know, please select what filesystem(s) you are using on the + system that is experiencing the problem. This can be especially helpful + if the issue is related to either the disk or memory widgets. multiple: true options: - ext4 @@ -76,12 +90,15 @@ body: attributes: label: What version of bottom are you running? description: > - Please specify which version of `bottom` you're running that is causing problems. You can find this with - `btm -V`. If you are using a nightly/non-release version, please also specify that. + Please specify which version of `bottom` you're running that is causing + problems. You can find this with `btm -V`. If you are using a + nightly/non-release version, please also specify that. - It would also be helpful if you are not running [the latest version](https://github.com/ClementTsang/bottom/releases/latest) - to try that as well to see if the issue has already been resolved. - placeholder: 0.14.3 + If you're not running the latest version, it would also be helpful to + see if [the latest + version](https://github.com/ClementTsang/bottom/releases/latest) solves + the issue first. + placeholder: 0.14.4 - type: textarea id: install @@ -90,9 +107,11 @@ body: attributes: label: How did you install bottom? description: > - Please describe how you installed `bottom`. If you manually compiled it, please also mention your _Rust version_. + Please describe how you installed `bottom`. If you manually compiled it, + please also mention your _Rust version_. - **Note: if you installed `bottom` from cargo, please ensure that you installed the right crate (https://crates.io/crates/bottom).** + **Note: if you installed `bottom` from cargo, please ensure that you + installed the right crate (https://crates.io/crates/bottom).** placeholder: Installed bottom through the Arch official repos. # TODO: After some point also add in a `btm check` invocation @@ -128,7 +147,8 @@ body: attributes: label: What is the actual behaviour? description: > - Describe the behaviour you actually see. If possible, provide screenshots/videos. + Describe the behaviour you actually see. If possible, provide + screenshots/videos. placeholder: | Example: I am unable to see information about my encrypted partition. @@ -140,10 +160,12 @@ body: attributes: label: How can we reproduce this? description: > - Provide detailed steps on _how_ to reproduce your problem, to the best of your ability. Be as detailed as - possible. Include any config files or flags used. If possible, provide screenshots/videos of the issue. + Provide detailed steps on _how_ to reproduce your problem, to the best + of your ability. Be as detailed as possible. Include any config files or + flags used. If possible, provide screenshots/videos of the issue. - Remember - if maintainers cannot reproduce the issue, it will be very hard to fix! + Remember - if maintainers cannot reproduce the issue, it will be very + hard to fix! placeholder: | Example: 1. Mount a LUKS encrypted partition. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index e47f709c..59dd12be 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ name: Feature request description: Got a good idea that hasn't already been suggested? Mention it here! -labels: ["feature"] +labels: [ "feature" ] body: - type: checkboxes id: acknowledgements @@ -8,10 +8,16 @@ body: label: Checklist options: - label: > - I've looked through [the documentation](https://bottom.pages.dev/nightly/) and - [existing open issues](https://github.com/ClementTsang/bottom/issues?q=is%3Aopen+is%3Aissue+label%3Afeature) + I've looked through [the + documentation](https://bottom.pages.dev/nightly/) and [existing + open + issues](https://github.com/ClementTsang/bottom/issues?q=is%3Aopen+is%3Aissue+label%3Afeature) for similar feature requests. required: true + - label: > + I've read through the [AI + policy](https://github.com/ClementTsang/bottom/blob/main/AI_POLICY.md) + and am following it when reporting this feature request. - type: textarea id: description @@ -20,10 +26,12 @@ body: attributes: label: Describe the feature request description: > - Please describe what behaviour you are looking for, the motivation for it, and use cases where this feature - would be helpful to both you and others. Try to be clear and concise. + Please describe what behaviour you are looking for, the motivation for + it, and use cases where this feature would be helpful to both you and + others. Try to be clear and concise. - If you have any ideas to implement this feature as well, feel free to write them down here too. + If you have any ideas to implement this feature as well, feel free to + write them down here too. placeholder: | Example: It would be nice to support FreeBSD, as I and others often use similar tools on my FreeBSD-based system. diff --git a/.github/ISSUE_TEMPLATE/packaging.yml b/.github/ISSUE_TEMPLATE/packaging.yml index 153e160d..adc8a568 100644 --- a/.github/ISSUE_TEMPLATE/packaging.yml +++ b/.github/ISSUE_TEMPLATE/packaging.yml @@ -1,30 +1,38 @@ name: Packaging description: For issues, questions, or requests regarding packaging or distribution. -labels: ["packaging"] +labels: [ "packaging" ] body: - type: markdown attributes: value: > - If this is an issue about supporting a new package/installation method for a platform you use, please - consider maintaining it yourself/with others and submitting a PR or issue with a link to it - they'll be - very much appreciated and likely added to the README quickly. [The documentation on packaging/distribution](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/) - may be helpful in setting things up. If there are some issues with bottom itself causing problems with - packaging, feel free to open an appropriate issue. + If this is an issue about supporting a new package/installation method + for a platform you use, please consider maintaining it yourself/with + others and submitting a PR or issue with a link to it - they'll be very + much appreciated and likely added to the README quickly. [The + documentation on + packaging/distribution](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/) + may be helpful in setting things up. If there are some issues with + bottom itself causing problems with packaging, feel free to open an + appropriate issue. - If this is an issue regarding a specific existing distribution channel, feel free to report issues here if they - are related to the following sources: + If this is an issue regarding a specific existing distribution channel, + feel free to report issues here if they are related to the following + sources: * [crates.io](https://crates.io/crates/bottom) * [Binary releases/packages released on GitHub](https://github.com/ClementTsang/bottom/releases) - For any other distribution channel, please first try to contact the package maintainers where appropriate - to get help regarding distribution-specific issues (e.g. the package has issues installing, the package - is outdated, etc.) before reaching out here. While I am happy to help where possible, I do not - personally use many of the various ways people distribute bottom. As such, I might lack the - platform-specific context, knowledge, or tools to be able to help you at all regarding the - distribution method, and the best I can do is just point you to the package maintainer. + For any other distribution channel, please first try to contact the + package maintainers where appropriate to get help regarding + distribution-specific issues (e.g. the package has issues installing, + the package is outdated, etc.) before reaching out here. While I am + happy to help where possible, I do not personally use many of the + various ways people distribute bottom. As such, I might lack the + platform-specific context, knowledge, or tools to be able to help you at + all regarding the distribution method, and the best I can do is just + point you to the package maintainer. - type: checkboxes id: acknowledgements @@ -34,6 +42,10 @@ body: - label: > I have read and understood the above text. required: true + - label: > + I've read through the [AI + policy](https://github.com/ClementTsang/bottom/blob/main/AI_POLICY.md) + and am following it when reporting this issue. - type: textarea id: description diff --git a/README.md b/README.md index fcdb88b5..22c73ffc 100644 --- a/README.md +++ b/README.md @@ -166,8 +166,8 @@ Alternatively, you can use `cargo install` using the repo as the source. rustup update stable # Option 1 - Download an archive from releases and install -curl -LO https://github.com/ClementTsang/bottom/archive/0.14.3.tar.gz -tar -xzvf 0.14.3.tar.gz +curl -LO https://github.com/ClementTsang/bottom/archive/0.14.4.tar.gz +tar -xzvf 0.14.4.tar.gz cargo install --path . --locked # Option 2 - Manually clone the repo and install @@ -219,20 +219,20 @@ Some examples of installing it this way: ```bash # x86-64 -curl -LO https://github.com/ClementTsang/bottom/releases/download/0.14.3/bottom_0.14.3-1_amd64.deb -sudo dpkg -i bottom_0.14.3-1_amd64.deb +curl -LO https://github.com/ClementTsang/bottom/releases/download/0.14.4/bottom_0.14.4-1_amd64.deb +sudo dpkg -i bottom_0.14.4-1_amd64.deb # ARM64 -curl -LO https://github.com/ClementTsang/bottom/releases/download/0.14.3/bottom_0.14.3-1_arm64.deb -sudo dpkg -i bottom_0.14.3-1_arm64.deb +curl -LO https://github.com/ClementTsang/bottom/releases/download/0.14.4/bottom_0.14.4-1_arm64.deb +sudo dpkg -i bottom_0.14.4-1_arm64.deb # ARM -curl -LO https://github.com/ClementTsang/bottom/releases/download/0.14.3/bottom_0.14.3-1_armhf.deb -sudo dpkg -i bottom_0.14.3-1_armhf.deb +curl -LO https://github.com/ClementTsang/bottom/releases/download/0.14.4/bottom_0.14.4-1_armhf.deb +sudo dpkg -i bottom_0.14.4-1_armhf.deb # musl-based -curl -LO https://github.com/ClementTsang/bottom/releases/download/0.14.3/bottom-musl_0.14.3-1_amd64.deb -sudo dpkg -i bottom-musl_0.14.3-1_amd64.deb +curl -LO https://github.com/ClementTsang/bottom/releases/download/0.14.4/bottom-musl_0.14.4-1_amd64.deb +sudo dpkg -i bottom-musl_0.14.4-1_amd64.deb ``` ### Exherbo Linux @@ -274,8 +274,8 @@ sudo dnf install bottom For example: ```bash -curl -LO https://github.com/ClementTsang/bottom/releases/download/0.14.3/bottom-0.14.3-1.x86_64.rpm -sudo dnf install ./bottom-0.14.3-1.x86_64.rpm +curl -LO https://github.com/ClementTsang/bottom/releases/download/0.14.4/bottom-0.14.4-1.x86_64.rpm +sudo dnf install ./bottom-0.14.4-1.x86_64.rpm ``` ### Gentoo