From a4bd08de5889f1bb21bfdfbd5877475573ed4d1e Mon Sep 17 00:00:00 2001 From: Michal Date: Sun, 24 Jul 2022 16:26:47 +0100 Subject: [PATCH] Documentation slight changes --- docs/COMMON_FEATURES.md | 2 -- docs/REPOSITORY_MODE.md | 5 ++++- docs/WORKSPACE_MODE.md | 8 +++++--- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/COMMON_FEATURES.md b/docs/COMMON_FEATURES.md index 5ff985a..3a5c8a7 100644 --- a/docs/COMMON_FEATURES.md +++ b/docs/COMMON_FEATURES.md @@ -25,8 +25,6 @@ enabled = false key = "" on_gen = false -[mode.workspace] - [repositories] repos = [ "foo:repo1", diff --git a/docs/REPOSITORY_MODE.md b/docs/REPOSITORY_MODE.md index edcae1b..3242a8a 100644 --- a/docs/REPOSITORY_MODE.md +++ b/docs/REPOSITORY_MODE.md @@ -6,7 +6,7 @@ PacManage your repositories in style! As opposed to the rather barren Workspace mode, the Repository mode config is rather fleshed out, and we have a few options to choose from. -Let's take an example config, +Let's take an example section from a Repository mode config, ```toml [mode.repository] @@ -36,3 +36,6 @@ Calling back to the example above, we can see 3 config keys: - `key`: Defines the GPG key ID to use for signing. - `on_gen`: Defines whether to sign packages when they are built, or all at once on repository generation (this is also recommended). +--- + +You can return to [Getting Started](GETTING_STARTED.md) page here! diff --git a/docs/WORKSPACE_MODE.md b/docs/WORKSPACE_MODE.md index 5bfd573..3167365 100644 --- a/docs/WORKSPACE_MODE.md +++ b/docs/WORKSPACE_MODE.md @@ -3,6 +3,8 @@ You'll never have to work(space) another day in your life! ### Workspace Config +Taking an example section from the Workspace mode config, + ```toml [mode.workspace] git_info = true @@ -22,8 +24,8 @@ The key for the values is as follows: These will be typically displayed in either Green (Clean) or Red (Dirty) -However, if colorblind is set to true, the colors will instead be set to Blue (Clean) or Dark Red (Dirty), to be more discernible to colorblind users +However, if `colorblind` is set to true, the colors will instead be set to Blue (Clean) or Dark Red (Dirty), to be more discernible to colorblind users -### For Now... +--- -You can return to [Getting Started](GETTING_STARTED.md), or head directly into [Repository Mode](REPOSITORY_MODE.md) to see where Malachite really shines! \ No newline at end of file +You can return to [Getting Started](GETTING_STARTED.md) page here! \ No newline at end of file