From f8b8a21748d7b7a9298168328fad7b28cab65a12 Mon Sep 17 00:00:00 2001 From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> Date: Fri, 28 Mar 2025 00:22:40 -0400 Subject: [PATCH] docs: use local link in docs to reference itself & missing CPU config (#1704) * docs: use local link in docs to reference itself * also fix missing cpu config docs --- docs/content/contribution/documentation.md | 2 +- docs/mkdocs.yml | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/content/contribution/documentation.md b/docs/content/contribution/documentation.md index ac09e865..fc600dbc 100644 --- a/docs/content/contribution/documentation.md +++ b/docs/content/contribution/documentation.md @@ -12,7 +12,7 @@ There are a few areas where documentation changes are often needed: - 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 [extended documentation](../index.md) (what you're reading right now) - The [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md) ## How should I add/update documentation? diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index fc4fbf7a..992f4e63 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -166,11 +166,12 @@ nav: - "Command-line Options": configuration/command-line-options.md - "Config File": - configuration/config-file/index.md - - "Flags": configuration/config-file/flags.md - - "Styling": configuration/config-file/styling.md - - "Layout": configuration/config-file/layout.md + - "CPU Widget": configuration/config-file/cpu.md - "Data Filtering": configuration/config-file/data-filtering.md - - "Processes": configuration/config-file/processes.md + - "Flags": configuration/config-file/flags.md + - "Layout": configuration/config-file/layout.md + - "Processes Widget": configuration/config-file/processes.md + - "Styling": configuration/config-file/styling.md - "Contribution": - "Issues, Pull Requests, and Discussions": contribution/issues-and-pull-requests.md - "Documentation": contribution/documentation.md