mirror of
https://github.com/ClementTsang/bottom.git
synced 2024-09-11 03:35:35 +03:00
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
This commit is contained in:
parent
76d2e83efa
commit
e1be318177
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
@ -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)_
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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":
|
||||
|
Loading…
Reference in New Issue
Block a user