generate the doc

docs/nu-git-manager-sugar/extra/gm-report.md

@@ -1,4 +1,4 @@
-# `gm report` from `nu-git-manager-sugar extra` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/extra.nu#L23))
+# `gm report` from `nu-git-manager-sugar extra` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/extra.nu#L27))
 get a full report about the local store of repositories
 
 ## Examples

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

@@ -1,6 +1,6 @@
 # Module `nu-git-manager-sugar extra`
 ## Description
-
+extends the core `gm` command with additional subcommands.
 
 ## Commands
 - [`gm report`](gm-report.md)

docs/nu-git-manager-sugar/git/gm-repo-bisect.md

@@ -1,4 +1,4 @@
-# `gm repo bisect` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L380))
+# `gm repo bisect` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L384))
 bisect a worktree by running a piece of code repeatedly
 
 # Examples

docs/nu-git-manager-sugar/git/gm-repo-branch-interactive-delete.md

@@ -1,4 +1,4 @@
-# `gm repo branch interactive-delete` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L226))
+# `gm repo branch interactive-delete` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L230))
 remove a branch interactively
 
 

docs/nu-git-manager-sugar/git/gm-repo-branch-wipe.md

@@ -1,4 +1,4 @@
-# `gm repo branch wipe` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L113))
+# `gm repo branch wipe` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L117))
 wipe a branch completely, i.e. both locally and remotely
 
 

docs/nu-git-manager-sugar/git/gm-repo-branches.md

@@ -1,4 +1,4 @@
-# `gm repo branches` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L72))
+# `gm repo branches` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L76))
 inspect local branches
 
 > **Note**  

docs/nu-git-manager-sugar/git/gm-repo-compare.md

@@ -1,4 +1,4 @@
-# `gm repo compare` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L31))
+# `gm repo compare` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L35))
 compare the changes between two revisions, from a target to the "head"
 
 

docs/nu-git-manager-sugar/git/gm-repo-fetch-branch.md

@@ -1,4 +1,4 @@
-# `gm repo fetch branch` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L174))
+# `gm repo fetch branch` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L178))
 fetch a remote branch locally, without pulling down the whole remote
 
 

docs/nu-git-manager-sugar/git/gm-repo-get-commit.md

@@ -1,4 +1,4 @@
-# `gm repo get commit` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L24))
+# `gm repo get commit` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L28))
 get the commit hash of any revision
 
 ## Examples

docs/nu-git-manager-sugar/git/gm-repo-goto-root.md

@@ -1,4 +1,4 @@
-# `gm repo goto root` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L52))
+# `gm repo goto root` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L56))
 go to the root of the repository from anywhere in the worktree
 
 ## Examples

docs/nu-git-manager-sugar/git/gm-repo-is-ancestor.md

@@ -1,4 +1,4 @@
-# `gm repo is-ancestor` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L140))
+# `gm repo is-ancestor` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L144))
 return true iif the first revision is an ancestor of the second
 
 ## Examples

docs/nu-git-manager-sugar/git/gm-repo-ls.md

@@ -1,4 +1,4 @@
-# `gm repo ls` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L270))
+# `gm repo ls` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L274))
 get some information about a repo
 
 

docs/nu-git-manager-sugar/git/gm-repo-query.md

@@ -1,4 +1,4 @@
-# `gm repo query` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L320))
+# `gm repo query` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L324))
 queries the `.git/` directory as a database with `nu_plugin_git_query`
 
 ## Examples

docs/nu-git-manager-sugar/git/gm-repo-remote-list.md

@@ -1,4 +1,4 @@
-# `gm repo remote list` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L159))
+# `gm repo remote list` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L163))
 get the list of all the remotes in the current repository
 
 ## Examples

docs/nu-git-manager-sugar/git/gm-repo-switch.md

@@ -1,4 +1,4 @@
-# `gm repo switch` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L246))
+# `gm repo switch` from `nu-git-manager-sugar git` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/mod.nu#L250))
 switch between branches interactively
 
 

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

@@ -1,6 +1,6 @@
 # Module `nu-git-manager-sugar git`
 ## Description
-
+ships a bunch of helper commands that augments the capabilities of Git.
 
 ## Commands
 - [`gm repo bisect`](gm-repo-bisect.md)

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

@@ -1,6 +1,6 @@
 # Module `nu-git-manager-sugar git prompt`
 ## Description
-
+provides a command to setup a Git-based prompt for Nushell.
 
 ## Commands
 - [`setup`](setup.md)

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

@@ -1,4 +1,4 @@
-# `setup` from `nu-git-manager-sugar git prompt` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/prompt.nu#L62))
+# `setup` from `nu-git-manager-sugar git prompt` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/git/prompt.nu#L66))
 setup the Git prompt of NGM
 
 the different sections of the prompt are the following, in order and separated by a single space:

docs/nu-git-manager-sugar/github/gm-gh-pr-checkout.md

@@ -1,4 +1,4 @@
-# `gm gh pr checkout` from `nu-git-manager-sugar github` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/github.nu#L211))
+# `gm gh pr checkout` from `nu-git-manager-sugar github` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/github.nu#L215))
 checkout one of the repo's PR interactively
 
 

docs/nu-git-manager-sugar/github/gm-gh-query-api.md

@@ -1,4 +1,4 @@
-# `gm gh query-api` from `nu-git-manager-sugar github` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/github.nu#L83))
+# `gm gh query-api` from `nu-git-manager-sugar github` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/github.nu#L87))
 query the GitHub API for any end point
 
 > :bulb: **Note**  

docs/nu-git-manager-sugar/github/gm-gh-query-releases.md

@@ -1,4 +1,4 @@
-# `gm gh query-releases` from `nu-git-manager-sugar github` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/github.nu#L188))
+# `gm gh query-releases` from `nu-git-manager-sugar github` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/github.nu#L192))
 list the releases of a GitHub repository
 
 ## Examples

docs/nu-git-manager-sugar/github/gm-gh-query-user.md

@@ -1,4 +1,4 @@
-# `gm gh query-user` from `nu-git-manager-sugar github` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/github.nu#L203))
+# `gm gh query-user` from `nu-git-manager-sugar github` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager-sugar/nu-git-manager-sugar/github.nu#L207))
 get information about a GitHub user
 
 ## Examples:

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

@@ -1,6 +1,6 @@
 # Module `nu-git-manager-sugar github`
 ## Description
-
+provides helper commands to simplify the use of the GitHub CLI.
 
 ## Commands
 - [`gm gh pr checkout`](gm-gh-pr-checkout.md)

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

@@ -1,6 +1,7 @@
 # Module `nu-git-manager-sugar`
 ## Description
-
+`nu-git-manager-sugar` is the additional module and package of NGM, with sugar
+on top.
 
 ## Commands
 no commands

docs/nu-git-manager/gm-clean.md

@@ -1,4 +1,4 @@
-# `gm clean` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L552))
+# `gm clean` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L560))
 clean the store
 
 this command will mainly remove empty directory recursively.

docs/nu-git-manager/gm-clone.md

@@ -1,4 +1,4 @@
-# `gm clone` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L88))
+# `gm clone` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L96))
 clone a remote Git repository into your local store
 
 will give a nice error if the repository is already in the local store.

docs/nu-git-manager/gm-list.md

@@ -1,4 +1,4 @@
-# `gm list` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L216))
+# `gm list` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L224))
 list all the local repositories in your local store
 
 **/!\\** this command will return sanitized paths. **/!\\**

docs/nu-git-manager/gm-remove.md

@@ -1,4 +1,4 @@
-# `gm remove` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L354))
+# `gm remove` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L362))
 remove one of the repositories from your local store
 
 ## Examples

docs/nu-git-manager/gm-squash-forks.md

@@ -1,4 +1,4 @@
-# `gm squash-forks` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L475))
+# `gm squash-forks` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L483))
 squash multi-directory forks into a single repo
 
 Here, two forks are defined as *two non-grafted repositories that share the same initial commit,

docs/nu-git-manager/gm-status.md

@@ -1,4 +1,4 @@
-# `gm status` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L284))
+# `gm status` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L292))
 get current status about the repositories managed by NGM
 
 **/!\\** `$.root.path` and `$.cache.path` will be sanitized **/!\\**

docs/nu-git-manager/gm-update-cache.md

@@ -1,4 +1,4 @@
-# `gm update-cache` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L317))
+# `gm update-cache` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L325))
 update the local cache of repositories
 
 ## Examples

docs/nu-git-manager/gm.md

@@ -1,4 +1,4 @@
-# `gm` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L55))
+# `gm` from `nu-git-manager` (see [source](https://github.com/amtoine/nu-git-manager/blob/main/pkgs/nu-git-manager/nu-git-manager/mod.nu#L63))
 manage your Git repositories with the main command of NGM
 
 ### the location for the store

docs/nu-git-manager/index.md

@@ -1,6 +1,6 @@
 # Module `nu-git-manager`
 ## Description
-
+nu-git-manager is the core module and package of NGM.
 
 ## Commands
 - [`gm`](gm.md)