diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 718acb2c..ddf0a0b3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,7 +6,7 @@ labels: "bug" assignees: "" --- -Before you report, please take a look at [Troubleshooting](https://bottom.pages.dev/nightly/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://bottom.pages.dev/nightly/support/#known-problems) to see if your problem is already reported/known/fixed. +Before you report, please take a look at [Troubleshooting](https://clementtsang.github.io/bottom/nightly/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://clementtsang.github.io/bottom/nightly/support/#known-problems) to see if your problem is already reported/known/fixed. Also, **please fill in all fields if possible** - if the issue is too hard to reproduce or vague, it may not be fixed! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index df8980d6..9cd22817 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -11,4 +11,4 @@ assignees: "" Please describe what behaviour you are looking for, the motivation for it, and use cases for where this feature would be helpful. Try to be clear and concise - more details are usually helpful, but don't ramble on too much. -Also try to see if this feature already exists first [in the documentation](https://bottom.pages.dev/nightly/). +Also try to see if this feature already exists first [in the documentation](https://clementtsang.github.io/bottom/nightly/). diff --git a/.github/ISSUE_TEMPLATE/packaging.md b/.github/ISSUE_TEMPLATE/packaging.md index f3aa1c1e..5a008f55 100644 --- a/.github/ISSUE_TEMPLATE/packaging.md +++ b/.github/ISSUE_TEMPLATE/packaging.md @@ -17,4 +17,4 @@ Some notes: - If this issue is about supporting a new package manager/installation method, please do consider maintaining it yourself and sending in a PR, and I'll be glad accept it! - See [the documentation](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/) for more information. + See [the documentation](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/) for more information. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94503f8c..27dd0d4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,13 +24,13 @@ If you want to directly contribute documentation changes or code, follow this! T 4. Wait for the tests to pass. These consist of clippy lints, rustfmt checks, and basic tests. **If you are a first time contributor, skip to the next step for now, as GitHub Actions requires approval to run.** 5. Ask a maintainer to review your pull request. If changes are suggested or any comments are made, they should probably be addressed. Once it looks good, it'll be merged! -For more details, see [here](https://bottom.pages.dev/nightly/contribution/issues-and-pull-requests/). +For more details, see [here](https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/). ### Documentation -For contributing to documentation, see [here](https://bottom.pages.dev/nightly/contribution/documentation/). +For contributing to documentation, see [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/). ### Packaging -If you want to become a package maintainer, look [here](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/) +If you want to become a package maintainer, look [here](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/) for instructions on how to build bottom and add installation instructions to the README. diff --git a/README.md b/README.md index e3a2a616..5b05fd2e 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ [CI status](https://github.com/ClementTsang/bottom/actions?query=branch%3Amaster) [Codecov](https://app.codecov.io/gh/ClementTsang/bottom) [crates.io link](https://crates.io/crates/bottom) -[Nightly documentation](https://bottom.pages.dev/nightly) -[Stable documentation](https://bottom.pages.dev/stable) +[Nightly documentation](https://clementtsang.github.io/bottom/nightly) +[Stable documentation](https://clementtsang.github.io/bottom/stable) A cross-platform graphical process/system monitor with a customizable interface and a multitude of features. Supports Linux, macOS, and Windows. Inspired by [gtop](https://github.com/aksakalli/gtop), [gotop](https://github.com/xxxserxxx/gotop), and [htop](https://github.com/htop-dev/htop/). @@ -23,26 +23,26 @@ As (yet another) process/system visualization and management application, bottom - Graphical visualization widgets for: - - [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 + - [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 with support for zooming in/out the current time interval displayed. - Widgets for displaying info about: - - [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/) + - [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/) -- [A process widget](https://bottom.pages.dev/nightly/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for: +- [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: - Kill signals - Tree mode - Cross-platform support for Linux, macOS, and Windows, with more planned in the future. -- [Customizable behaviour](https://bottom.pages.dev/nightly/configuration/command-line-flags/) that can be controlled with command-line flags or a config file, such as: +- [Customizable behaviour](https://clementtsang.github.io/bottom/nightly/configuration/command-line-flags/) that can be controlled with command-line flags or a config file, such as: - Custom and pre-built colour themes - Changing the default behaviour of some widgets @@ -51,12 +51,12 @@ As (yet another) process/system visualization and management application, bottom - Some other nice stuff, like: - - [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) + - [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) - And more! -You can find more details in [the documentation](https://bottom.pages.dev/nightly/usage/general-usage/). +You can find more details in [the documentation](https://clementtsang.github.io/bottom/nightly/usage/general-usage/). ## Support @@ -69,7 +69,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 expected to be built and tested using the most recent version of stable Rust. -For more details on known problems and unsupported platforms, feel free to check out [the documentation page on support](https://bottom.pages.dev/nightly/support). +For more details on known problems and unsupported platforms, feel free to check out [the documentation page on support](https://clementtsang.github.io/bottom/nightly/support). ## Installation @@ -232,16 +232,16 @@ The release binaries are packaged with shell auto-completion files for bash, fis 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](https://bottom.pages.dev/nightly/). +- For info on key and mouse bindings, press `?` inside bottom or refer to the [documentation](https://clementtsang.github.io/bottom/nightly/). -You can find more information on usage in the [documentation](https://bottom.pages.dev/nightly/). +You can find more information on usage in the [documentation](https://clementtsang.github.io/bottom/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 one can change as appropriate. -More details on configuration can be found [in the documentation](https://bottom.pages.dev/nightly/configuration/config-file/default-config/). +More details on configuration can be found [in the documentation](https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/). ## Contribution diff --git a/docs/content/contribution/documentation.md b/docs/content/contribution/documentation.md index 771b3210..75952b7f 100644 --- a/docs/content/contribution/documentation.md +++ b/docs/content/contribution/documentation.md @@ -9,7 +9,7 @@ There are a few areas where documentation changes are often needed: -- The [extended documentation](https://bottom.pages.dev/nightly/) (AKA here) +- The [extended documentation](https://clementtsang.github.io/bottom/nightly/) (AKA here) - The [`README.md`](https://github.com/ClementTsang/bottom/blob/master/README.md) - The help menu inside of the application (located [here](https://github.com/ClementTsang/bottom/blob/master/src/constants.rs)) - The [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 90336e41..bcc25d9c 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://bottom.pages.dev +site_url: https://clementtsang.github.io/bottom site_description: >- Yet another cross-platform graphical process/system monitor, inspired by gtop, gotop, and htop. docs_dir: "content/"