From e1be318177ed0447c8997df166987dee1a48e343 Mon Sep 17 00:00:00 2001 From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> Date: Mon, 7 Nov 2022 23:36:27 -0500 Subject: [PATCH] docs: update usage and config, add blurb in home (#876) * docs: update usage and config, add blurb in home * add doc pages to pr template --- .github/pull_request_template.md | 2 +- docs/content/index.md | 6 ++++++ docs/content/usage/general-usage.md | 2 ++ docs/mkdocs.yml | 2 +- 4 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2abadfc5..67007c31 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -24,7 +24,7 @@ _If relevant, ensure the following have been met:_ - [ ] _Areas your change affects have been linted using rustfmt (`cargo fmt`)_ - [ ] _The change has been tested and doesn't appear to cause any unintended breakage_ -- [ ] _Documentation has been added/updated if needed (`README.md`, help menu, etc.)_ +- [ ] _Documentation has been added/updated if needed (`README.md`, help menu, doc pages, etc.)_ - [ ] _The pull request passes the provided CI pipeline_ - [ ] _There are no merge conflicts_ - [ ] _If relevant, new tests were added (don't worry too much about coverage)_ diff --git a/docs/content/index.md b/docs/content/index.md index 2623513a..aab3c48a 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -27,6 +27,12 @@ This site serves as extended documentation for bottom alongside the [`README.md` To install bottom, refer to [the installation section of the `README.md`](https://github.com/ClementTsang/bottom#installation), which contains a list of all the installation methods. +## Usage and configuration + +You can refer to the [usage](./usage/general-usage/) pages on how to use bottom (e.g. keybinds, some features, a general overview of what each widget does). + +To configure bottom, refer to the [configuration](./configuration/command-line-flags/) pages (e.g. how it behaves, how it looks). + ## Contribution New contributors are always welcome! See the [contribution](./contribution/issues-and-pull-requests/) section for how to contribute to diff --git a/docs/content/usage/general-usage.md b/docs/content/usage/general-usage.md index 6630ea69..fa7f0c63 100644 --- a/docs/content/usage/general-usage.md +++ b/docs/content/usage/general-usage.md @@ -16,6 +16,8 @@ btm -h btm --help ``` +You can also see keybinds and basic usage details in bottom by pressing ++question++, which will open a help menu. + ## Features ### Expansion diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 23c63890..9c94667a 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -128,6 +128,7 @@ nav: - "Unofficial Support": support/unofficial.md - "Usage": - "General Usage": usage/general-usage.md + - "Basic Mode": usage/basic-mode.md - "Widgets": - "CPU Widget": usage/widgets/cpu.md - "Memory Widget": usage/widgets/memory.md @@ -136,7 +137,6 @@ nav: - "Disk Widget": usage/widgets/disk.md - "Temperature Widget": usage/widgets/temperature.md - "Battery Widget": usage/widgets/battery.md - - "Basic Mode": usage/basic-mode.md - "Configuration": - "Command-line Flags": configuration/command-line-flags.md - "Config File":