From 16449f2697f364d10d9ca31188cbc724c9073f8e Mon Sep 17 00:00:00 2001 From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> Date: Sun, 12 Oct 2025 03:26:22 -0400 Subject: [PATCH] docs: use bottom.pages.dev (#1703) * docs: use bottom.pages.dev This _might_ stick, this might not. I may only do this after releasing one more stable version. We'll see. * fix schema --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/ISSUE_TEMPLATE/packaging.yml | 2 +- CONTRIBUTING.md | 8 ++-- Cargo.toml | 2 +- README.md | 42 ++++++++++---------- docs/mkdocs.yml | 2 +- scripts/windows/choco/bottom.nuspec.template | 2 +- src/lib.rs | 2 +- wix/main.wxs | 2 +- 10 files changed, 34 insertions(+), 34 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 70f2a815..296fa242 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -8,8 +8,8 @@ body: label: Checklist options: - label: > - I've looked through the [troubleshooting docs](https://clementtsang.github.io/bottom/nightly/troubleshooting), - [the known problems list](https://clementtsang.github.io/bottom/nightly/support/official/#known-problems), and + 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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index bbb294a8..e47f709c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -8,7 +8,7 @@ body: label: Checklist options: - label: > - I've looked through [the documentation](https://clementtsang.github.io/bottom/nightly/) and + 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 diff --git a/.github/ISSUE_TEMPLATE/packaging.yml b/.github/ISSUE_TEMPLATE/packaging.yml index c54bad83..153e160d 100644 --- a/.github/ISSUE_TEMPLATE/packaging.yml +++ b/.github/ISSUE_TEMPLATE/packaging.yml @@ -7,7 +7,7 @@ body: 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://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/) + 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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6374e9e6..1d8bd7b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ If you want to directly contribute documentation changes or code, follow this! T 1. Fork the project. 2. Make your changes. -3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/) for tips on documentation. +3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See [here](https://bottom.pages.dev/nightly/contribution/documentation/) for tips on documentation. 4. Commit and create a pull request to merge into the `main` branch. **Please fill out the pull request template**. 5. Ask a maintainer to review your pull request. - Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a @@ -28,13 +28,13 @@ If you want to directly contribute documentation changes or code, follow this! T 6. Once it looks good, it'll be merged! Note that _generally_, PRs are squashed to maintain repo cleanliness, though feel free to ask otherwise if that isn't preferable. -For more details, see [here](https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/). +For more details, see [here](https://bottom.pages.dev/nightly/contribution/issues-and-pull-requests/). ### Documentation -For contributing to documentation, see [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/). +For contributing to documentation, see [here](https://bottom.pages.dev/nightly/contribution/documentation/). ### Packaging -If you want to become a package maintainer, see [here](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/) +If you want to become a package maintainer, see [here](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/) for details on how to build bottom, how to generate/obtain completion files and manpages, and how to add installation instructions for the package to the README. diff --git a/Cargo.toml b/Cargo.toml index 9fd08b27..7812c3a8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,7 +4,7 @@ version = "0.11.2" repository = "https://github.com/ClementTsang/bottom" license = "MIT" description = "A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows." -documentation = "https://clementtsang.github.io/bottom/stable" +documentation = "https://bottom.pages.dev/stable" readme = "README.md" default-run = "btm" build = "build.rs" diff --git a/README.md b/README.md index b369d850..3f2b17c1 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ [CI status](https://github.com/ClementTsang/bottom/actions?query=branch%3Amain) [crates.io link](https://crates.io/crates/bottom) -[Stable documentation](https://clementtsang.github.io/bottom/stable) -[Nightly documentation](https://clementtsang.github.io/bottom/nightly) +[Stable documentation](https://bottom.pages.dev/stable) +[Nightly documentation](https://bottom.pages.dev/nightly) @@ -63,26 +63,26 @@ As (yet another) process/system visualization and management application, bottom - Graphical visualization widgets for: - - [CPU usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/) over time, at an average and per-core level - - [RAM and swap usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/) over time - - [Network I/O usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/network/) over time + - [CPU usage](https://bottom.pages.dev/nightly/usage/widgets/cpu/) over time, at an average and per-core level + - [RAM and swap usage](https://bottom.pages.dev/nightly/usage/widgets/memory/) over time + - [Network I/O usage](https://bottom.pages.dev/nightly/usage/widgets/network/) over time with support for zooming in/out the current time interval displayed. - Widgets for displaying info about: - - [Disk capacity/usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/) - - [Temperature sensors](https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/) - - [Battery usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/) + - [Disk capacity/usage](https://bottom.pages.dev/nightly/usage/widgets/disk/) + - [Temperature sensors](https://bottom.pages.dev/nightly/usage/widgets/temperature/) + - [Battery usage](https://bottom.pages.dev/nightly/usage/widgets/battery/) -- [A process widget](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for: +- [A process widget](https://bottom.pages.dev/nightly/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for: - - [Kill signals](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/#process-termination) - - [Tree mode](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/#tree-mode) + - [Kill signals](https://bottom.pages.dev/nightly/usage/widgets/process/#process-termination) + - [Tree mode](https://bottom.pages.dev/nightly/usage/widgets/process/#tree-mode) - [Cross-platform support](https://github.com/ClementTsang/bottom#support) for Linux, macOS, and Windows, with more planned in the future. -- [Customizable behaviour](https://clementtsang.github.io/bottom/nightly/configuration/command-line-options/) that can be controlled with command-line options or a config file, such as: +- [Customizable behaviour](https://bottom.pages.dev/nightly/configuration/command-line-options/) that can be controlled with command-line options or a config file, such as: - Custom and built-in colour themes - Customizing widget behaviour @@ -91,12 +91,12 @@ As (yet another) process/system visualization and management application, bottom - And more: - - [An htop-inspired basic mode](https://clementtsang.github.io/bottom/nightly/usage/basic-mode/) - - [Expansion, which focuses on just one widget](https://clementtsang.github.io/bottom/nightly/usage/general-usage/#expansion) + - [An htop-inspired basic mode](https://bottom.pages.dev/nightly/usage/basic-mode/) + - [Expansion, which focuses on just one widget](https://bottom.pages.dev/nightly/usage/general-usage/#expansion) - And more! -You can find more details in [the documentation](https://clementtsang.github.io/bottom/nightly/usage/general-usage/). +You can find more details in [the documentation](https://bottom.pages.dev/nightly/usage/general-usage/). ## Support @@ -111,7 +111,7 @@ bottom _officially_ supports the following operating systems and corresponding a These platforms are tested to work for the most part and issues on these platforms will be fixed if possible. Furthermore, binaries are built and tested using the most recent version of stable Rust at the time. -For more details on supported platforms and known problems, check out [the documentation](https://clementtsang.github.io/bottom/nightly/support/official/). +For more details on supported platforms and known problems, check out [the documentation](https://bottom.pages.dev/nightly/support/official/). ### Unofficial @@ -129,7 +129,7 @@ A non-comprehensive list of some currently unofficially-supported platforms that - Linux (`armv6`, `armv7`, `powerpc64le`, `riscv64gc`) - Android (`arm64`) -For more details on unsupported platforms and known problems, check out [the documentation](https://clementtsang.github.io/bottom/nightly/support/unofficial/). +For more details on unsupported platforms and known problems, check out [the documentation](https://bottom.pages.dev/nightly/support/unofficial/). ## Installation @@ -434,20 +434,20 @@ The individual auto-completion files are also included in the stable/nightly rel You can run bottom using `btm`. - For help on flags, use `btm -h` for a quick overview or `btm --help` for more details. -- For info on key and mouse bindings, press `?` inside bottom or refer to the [documentation page](https://clementtsang.github.io/bottom/nightly/). +- For info on key and mouse bindings, press `?` inside bottom or refer to the [documentation page](https://bottom.pages.dev/nightly/). -You can find more information on usage in the [documentation](https://clementtsang.github.io/bottom/nightly/). +You can find more information on usage in the [documentation](https://bottom.pages.dev/nightly/). ## Configuration bottom accepts a number of command-line arguments to change the behaviour of the application as desired. Additionally, bottom will automatically generate a configuration file on the first launch, which can be changed. -More details on configuration can be found [in the documentation](https://clementtsang.github.io/bottom/nightly/configuration/config-file/). +More details on configuration can be found [in the documentation](https://bottom.pages.dev/nightly/configuration/config-file/). ## Troubleshooting -If some things aren't working, give the [troubleshooting page](https://clementtsang.github.io/bottom/nightly/troubleshooting) +If some things aren't working, give the [troubleshooting page](https://bottom.pages.dev/nightly/troubleshooting) a look. If things still aren't working, then consider asking [a question](https://github.com/ClementTsang/bottom/discussions) or filing a [bug report](https://github.com/ClementTsang/bottom/issues/new/choose) if you think it's a bug. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 66ca236a..882f7a53 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,7 +1,7 @@ # Site information site_name: bottom site_author: Clement Tsang -site_url: https://clementtsang.github.io/bottom +site_url: https://bottom.pages.dev site_description: >- A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows. docs_dir: "content/" diff --git a/scripts/windows/choco/bottom.nuspec.template b/scripts/windows/choco/bottom.nuspec.template index 7f622173..423672b2 100644 --- a/scripts/windows/choco/bottom.nuspec.template +++ b/scripts/windows/choco/bottom.nuspec.template @@ -31,7 +31,7 @@ This is a nuspec. It mostly adheres to https://docs.nuget.org/create/Nuspec-Refe true https://github.com/ClementTsang/bottom https://github.com/ClementTsang/choco-bottom - https://clementtsang.github.io/bottom/stable + https://bottom.pages.dev/stable https://github.com/ClementTsang/bottom/issues cli cross-platform terminal top tui monitoring bottom btm A customizable cross-platform graphical process/system monitor for the terminal. diff --git a/src/lib.rs b/src/lib.rs index cab6335b..9b48f11e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -5,7 +5,7 @@ //! **Note:** The following documentation is primarily intended for people to //! refer to for development purposes rather than the actual usage of the //! application. If you are instead looking for documentation regarding the -//! *usage* of bottom, refer to [here](https://clementtsang.github.io/bottom/stable/). +//! *usage* of bottom, refer to [here](https://bottom.pages.dev/stable/). pub(crate) mod app; mod utils { diff --git a/wix/main.wxs b/wix/main.wxs index 904f64c6..15bfce29 100644 --- a/wix/main.wxs +++ b/wix/main.wxs @@ -218,7 +218,7 @@ - +