add extra usage for modules in documentation (#173)

- should fix #172
- wait for nushell/nupm#62

docs/nu-git-manager-sugar/extra/index.md

@@ -2,5 +2,7 @@
 ## Description
 extends the core `gm` command with additional subcommands.
 
+/!\ this module is part of the optional NGM. /!\
+
 ## Commands
 - [`gm report`](gm-report.md)

docs/nu-git-manager-sugar/git/index.md

@@ -2,6 +2,8 @@
 ## Description
 ships a bunch of helper commands that augments the capabilities of Git.
 
+/!\ this module is part of the optional NGM. /!\
+
 ## Commands
 - [`gm repo bisect`](gm-repo-bisect.md)
 - [`gm repo branch interactive-delete`](gm-repo-branch-interactive-delete.md)

docs/nu-git-manager-sugar/git/prompt/index.md

@@ -2,5 +2,7 @@
 ## Description
 provides a command to setup a Git-based prompt for Nushell.
 
+/!\ this module is part of the optional NGM. /!\
+
 ## Commands
 - [`setup`](setup.md)

docs/nu-git-manager-sugar/github/index.md

@@ -2,6 +2,8 @@
 ## Description
 provides helper commands to simplify the use of the GitHub CLI.
 
+/!\ this module is part of the optional NGM. /!\
+
 ## Commands
 - [`gm gh pr checkout`](gm-gh-pr-checkout.md)
 - [`gm gh query-api`](gm-gh-query-api.md)

docs/nu-git-manager-sugar/index.md

@@ -3,6 +3,10 @@
 `nu-git-manager-sugar` is the additional module and package of NGM, with sugar
 on top.
 
+it ships things like extensions to the core `gm` command, augments Git with
+automation commands and can provide helper commands around utilities such as
+the GitHub CLI.
+
 ## Commands
 no commands
 

docs/nu-git-manager/index.md

@@ -2,6 +2,12 @@
 ## Description
 `nu-git-manager` is the core module and package of NGM.
 
+it features all required commands to interact with and manage Git repos.
+
+this module ships the `gm` command and a bunch of subcommands, allowing you to
+clone, list, remove, ..., repositories without worrying about where they are
+on your filesystem!
+
 ## Commands
 - [`gm`](gm.md)
 - [`gm clean`](gm-clean.md)

toolkit.nu

@@ -325,6 +325,8 @@ def document-module [
             "## Description",
             $module.usage,
             "",
+            $module.extra_usage,
+            "",
             "## Commands",
             $commands,
         ]