summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorClement Tsang <34804052+ClementTsang@users.noreply.github.com>2023-12-06 00:16:26 -0500
committerGitHub <noreply@github.com>2023-12-06 00:16:26 -0500
commitdab4b6c4832237375f00255ec52698c8a35a19bc (patch)
tree471093324480d30ffb5b2f878b6c5ba9a35f5f75 /docs
parentbc6a8d7febddc11fcd7c07287f3b07d9bba02a7c (diff)
other: master -> main (#1349)
* other: master -> main I'm so used to using `main` branch now that it's actually kinda annoying to use `master` for just this repo... so might as well rename it now. * overzealous change * wording * some wording * allow auto-cancel for tests if not main
Diffstat (limited to 'docs')
-rw-r--r--docs/content/configuration/config-file/layout.md2
-rw-r--r--docs/content/contribution/development/build_process.md4
-rw-r--r--docs/content/contribution/development/deploy_process.md4
-rw-r--r--docs/content/contribution/documentation.md20
-rw-r--r--docs/content/contribution/issues-and-pull-requests.md2
-rw-r--r--docs/content/contribution/packaging-and-distribution.md12
-rw-r--r--docs/content/support/unofficial.md6
-rw-r--r--docs/content/troubleshooting.md2
-rw-r--r--docs/mkdocs.yml2
9 files changed, 27 insertions, 27 deletions
diff --git a/docs/content/configuration/config-file/layout.md b/docs/content/configuration/config-file/layout.md
index 76bd6e33..c5f35465 100644
--- a/docs/content/configuration/config-file/layout.md
+++ b/docs/content/configuration/config-file/layout.md
@@ -54,4 +54,4 @@ Each component of the layout accepts a `ratio` value. If this is not set, it def
Furthermore, you can have duplicate widgets.
-For an example, look at the [default config](https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml), which contains the default layout.
+For an example, look at the [default config](https://github.com/ClementTsang/bottom/blob/main/sample_configs/default_config.toml), which contains the default layout.
diff --git a/docs/content/contribution/development/build_process.md b/docs/content/contribution/development/build_process.md
index 3ce28aa4..ea35ae17 100644
--- a/docs/content/contribution/development/build_process.md
+++ b/docs/content/contribution/development/build_process.md
@@ -10,7 +10,7 @@
## Overview
-bottom manages its own binary builds for nightly and stable release purposes. The core build workflow is handled by [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml), called by a wrapper workflow for [nightly](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/nightly.yml) and [stable](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/deployment.yml) releases. Builds take place via GitHub Actions.
+bottom manages its own binary builds for nightly and stable release purposes. The core build workflow is handled by [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml), called by a wrapper workflow for [nightly](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/nightly.yml) and [stable](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/deployment.yml) releases. Builds take place via GitHub Actions.
The main things built are:
@@ -18,7 +18,7 @@ The main things built are:
- MSI installer for Windows
- `.deb` package for Debian and its derivatives
-This documentation gives a high-level overview of the build process for each part. For the most up-to-date and detailed reference, definitely refer back to the [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml) file.
+This documentation gives a high-level overview of the build process for each part. For the most up-to-date and detailed reference, definitely refer back to the [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml) file.
## Binaries
diff --git a/docs/content/contribution/development/deploy_process.md b/docs/content/contribution/development/deploy_process.md
index b9664f79..ff660c68 100644
--- a/docs/content/contribution/development/deploy_process.md
+++ b/docs/content/contribution/development/deploy_process.md
@@ -12,8 +12,8 @@
bottom currently has two main deploy processes to worry about:
-- [Nightly](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/nightly.yml): a daily (00:00 UTC) GitHub action to build binary/installer files, and upload them to the [nightly release](https://github.com/ClementTsang/bottom/releases/tag/nightly). It can also be triggered manually as either a proper nightly release or a mock release.
-- [Stable](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/deployment.yml): a stable deployment, triggered manually or upon creation of a valid tag. This is a GitHub action that builds binary/installer files and uploads them to a new GitHub release.
+- [Nightly](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/nightly.yml): a daily (00:00 UTC) GitHub action to build binary/installer files, and upload them to the [nightly release](https://github.com/ClementTsang/bottom/releases/tag/nightly). It can also be triggered manually as either a proper nightly release or a mock release.
+- [Stable](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/deployment.yml): a stable deployment, triggered manually or upon creation of a valid tag. This is a GitHub action that builds binary/installer files and uploads them to a new GitHub release.
Furthermore, this workflow does not handle the following deployments, which must be manually handled:
diff --git a/docs/content/contribution/documentation.md b/docs/content/contribution/documentation.md
index 8922922a..ac09e865 100644
--- a/docs/content/contribution/documentation.md
+++ b/docs/content/contribution/documentation.md
@@ -10,10 +10,10 @@
There are a few areas where documentation changes are often needed:
-- 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 [`README.md`](https://github.com/ClementTsang/bottom/blob/main/README.md)
+- The help menu inside of the application (located [here](https://github.com/ClementTsang/bottom/blob/main/src/constants.rs))
- The [extended documentation](https://clementtsang.github.io/bottom/nightly/) (here)
-- The [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md)
+- The [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md)
## How should I add/update documentation?
@@ -23,20 +23,20 @@ There are a few areas where documentation changes are often needed:
<h3><code>README.md</code> or <code>CHANGELOG.md</code></h3>
- For changes to [`README.md`](https://github.com/ClementTsang/bottom/blob/master/README.md) and [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md), just follow the formatting provided and use any editor.
+ For changes to [`README.md`](https://github.com/ClementTsang/bottom/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md), just follow the formatting provided and use any editor.
- Generally, changes to [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md) will be handled
- by a maintainer, and changes should follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format, as
- well as link to the relevant PR or issue.
+ Generally, changes to [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md) will be handled
+ by a maintainer, and the contents of the file should follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+ format, as well as link to the relevant PR or issues.
<h3>Help menu</h3>
- For changes to the help menu, try to refer to the existing code within [`src/constants.rs`](https://github.com/ClementTsang/bottom/blob/master/src/constants.rs) on how the help menu is generated.
+ For changes to the help menu, try to refer to the existing code within [`src/constants.rs`](https://github.com/ClementTsang/bottom/blob/main/src/constants.rs) on how the help menu is generated.
<h3>Extended documentation</h3>
- For changes to the extended documentation, you'll probably want at least Python 3.11 (older versions should be fine
- though), [MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/),
+ For changes to the extended documentation, you'll probably want at least Python 3.11 (older and newer versions
+ should be fine), [MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/),
`mdx_truly_sane_lists`, and optionally [Mike](https://github.com/jimporter/mike) installed. These can help with
validating your changes locally.
diff --git a/docs/content/contribution/issues-and-pull-requests.md b/docs/content/contribution/issues-and-pull-requests.md
index 86e0d58f..7429595b 100644
--- a/docs/content/contribution/issues-and-pull-requests.md
+++ b/docs/content/contribution/issues-and-pull-requests.md
@@ -26,7 +26,7 @@ The expected workflow for a pull request is:
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](./documentation.md) for tips on documentation.
-4. Commit and create a pull request to merge into the `master` branch. **Please fill out the pull request template**.
+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
first-time contributor, you may need to wait for a maintainer to let CI run.
diff --git a/docs/content/contribution/packaging-and-distribution.md b/docs/content/contribution/packaging-and-distribution.md
index 4a0941ed..a41384c3 100644
--- a/docs/content/contribution/packaging-and-distribution.md
+++ b/docs/content/contribution/packaging-and-distribution.md
@@ -11,10 +11,10 @@ completion files for zsh, bash, fish, and Powershell, which you may want to also
process.
You can also find a nightly build in the [releases page](https://github.com/ClementTsang/bottom/releases), built every
-day at 00:00 UTC off of the master branch.
+day at 00:00 UTC off of the `main` branch.
In both cases, we use a combination of GitHub Actions and CirrusCI (mainly for FreeBSD and macOS M1) to create our
-release binaries. [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml)
+release binaries. [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml)
contains the GitHub Action workflow used to do both of these, if reference is needed.
## Building manually
@@ -34,7 +34,7 @@ cargo build --release --locked
### Manpage and completion generation
-bottom uses a [`build.rs`](https://github.com/ClementTsang/bottom/blob/master/build.rs) script to automatically generate
+bottom uses a [`build.rs`](https://github.com/ClementTsang/bottom/blob/main/build.rs) script to automatically generate
a manpage and shell completions for the following shells:
- Bash
@@ -54,13 +54,13 @@ This will automatically generate completion and manpage files in `target/tmp/bot
files, modify/delete either these files or set `BTM_GENERATE` to some other non-empty value to retrigger the build
script.
-For more information, you may want to look at either the [`build.rs`](https://github.com/ClementTsang/bottom/blob/master/build.rs)
-file or the [binary build CI workflow](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml).
+For more information, you may want to look at either the [`build.rs`](https://github.com/ClementTsang/bottom/blob/main/build.rs)
+file or the [binary build CI workflow](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml).
## Adding an installation source
Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add
-the installation method and any details to the [`README.md`](https://github.com/ClementTsang/bottom/blob/master/README.md)
+the installation method and any details to the [`README.md`](https://github.com/ClementTsang/bottom/blob/main/README.md)
file under the [Installation](https://github.com/ClementTsang/bottom#installation) section, as well as a corresponding
table of contents entry. Once that's done, open a pull request - these will usually be approved of very quickly.
diff --git a/docs/content/support/unofficial.md b/docs/content/support/unofficial.md
index 84a3d4c6..d7f7ac7a 100644
--- a/docs/content/support/unofficial.md
+++ b/docs/content/support/unofficial.md
@@ -7,9 +7,9 @@ on the problem at the end of the day, _issues on unsupported platforms are likel
Unofficially supported platforms known to compile/work:
- FreeBSD
-- Linux on ARMv7 and ARMv6 (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml))
-- Linux on PowerPC 64 LE (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml))
-- Linux on an RISC-V (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml), tested to run on an [Allwinner D1 Nezha](https://github.com/ClementTsang/bottom/issues/564))
+- Linux on ARMv7 and ARMv6 (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/ci.yml))
+- Linux on PowerPC 64 LE (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/ci.yml))
+- Linux on an RISC-V (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/ci.yml), tested to run on an [Allwinner D1 Nezha](https://github.com/ClementTsang/bottom/issues/564))
## Known problems
diff --git a/docs/content/troubleshooting.md b/docs/content/troubleshooting.md
index 4bdb7cda..db5b2c24 100644
--- a/docs/content/troubleshooting.md
+++ b/docs/content/troubleshooting.md
@@ -106,7 +106,7 @@ If your configuration files aren't working, here are a few things to try:
### Check the formatting
-It may be handy to refer to the automatically generated config files or the [sample configuration files](https://github.com/ClementTsang/bottom/tree/master/sample_configs).
+It may be handy to refer to the automatically generated config files or the [sample configuration files](https://github.com/ClementTsang/bottom/tree/main/sample_configs).
The config files also follow the [TOML](https://toml.io/en/) format.
Also make sure your config options are under the right table - for example, to set your temperature type, you must set it under the `[flags]` table:
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index f59e9ddc..81a484c1 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -8,7 +8,7 @@ docs_dir: "content/"
# Project information
repo_name: ClementTsang/bottom
repo_url: https://github.com/ClementTsang/bottom
-edit_uri: "edit/master/docs/content/"
+edit_uri: "edit/main/docs/content/"
# Theming
theme: