Update documentation generation with examples (#182)

* update docs * Docs changes * Add documentation for command@1 and just-text@1 * Docs changes * update * Docs changes * update * Docs changes * update * Docs changes * update * Docs changes * update * Docs changes * update * Docs changes * update * Docs changes --------- Co-authored-by: GitHub Action <[email protected]>
coenm · Sep 19, 2024 · a30e3be · a30e3be
1 parent 126e49b
commit a30e3be
Show file tree

Hide file tree

Showing 70 changed files with 1,240 additions and 868 deletions.
diff --git a/README.md b/README.md
@@ -58,7 +58,7 @@ See the [Search](docs/search.md) for more information.
 
 The order of the repositories shown in RepoM is customizable. The default is alphabetical on the repository name. Read more about ordering [here](docs_old/Ordering.md).
 
-The repositories shown in RepoM are filtered using the search box in RepoM. But the default set can also be configured using different presets. [This page](docs_old/Filtering.md) describes how to create custom filter presets.
+The repositories shown in RepoM are filtered using the search box in RepoM. But the default set can also be configured using different presets.
 
 ## Global configuration
 

diff --git a/README.source.md b/README.source.md
@@ -58,7 +58,7 @@ See the [Search](docs/search.md) for more information.
 
 The order of the repositories shown in RepoM is customizable. The default is alphabetical on the repository name. Read more about ordering [here](docs_old/Ordering.md).
 
-The repositories shown in RepoM are filtered using the search box in RepoM. But the default set can also be configured using different presets. [This page](docs_old/Filtering.md) describes how to create custom filter presets.
+The repositories shown in RepoM are filtered using the search box in RepoM. But the default set can also be configured using different presets.
 
 ## Global configuration
 

diff --git a/docs/mdsource/plugin_repom.plugin.azuredevops.generated.source.md b/docs/mdsource/plugin_repom.plugin.azuredevops.generated.source.md
@@ -28,6 +28,8 @@ To create a PAT, goto `https://dev.azure.com/[my-organisation]/_usersSettings/to
 
 This module contains the following methods, variables and/or constants:
 
+- [`azure-devops-create-pr@1`](#azure-devops-create-pr1)
+
 ## azure-devops-create-pr@1
 
 Action menu item to create a pull request in Azure Devops.

diff --git a/docs/mdsource/plugin_repom.plugin.clipboard.generated.source.md b/docs/mdsource/plugin_repom.plugin.clipboard.generated.source.md
@@ -10,6 +10,8 @@ This plugin has no configuration.
 
 This module contains the following methods, variables and/or constants:
 
+- [`clipboard-copy@1`](#clipboard-copy1)
+
 ## clipboard-copy@1
 
 This action makes it possible to copy text to the clipboard.

diff --git a/docs/mdsource/plugin_repom.plugin.sonarcloud.generated.source.md b/docs/mdsource/plugin_repom.plugin.sonarcloud.generated.source.md
@@ -27,6 +27,8 @@ The following default configuration is used:
 
 This module contains the following methods, variables and/or constants:
 
+- [`sonarcloud-set-favorite@1`](#sonarcloud-set-favorite1)
+
 ## sonarcloud-set-favorite@1
 
 Action to mark a repository as favorite within SonarCloud.

diff --git a/docs/mdsource/plugin_repom.plugin.webbrowser.generated.source.md b/docs/mdsource/plugin_repom.plugin.webbrowser.generated.source.md
@@ -55,6 +55,8 @@ Example configuration:
 
 This module contains the following methods, variables and/or constants:
 
+- [`browser@1`](#browser1)
+
 ## browser@1
 
 Action opening a webbrowser with the provided url.

diff --git a/docs/mdsource/repom.generated.source.md b/docs/mdsource/repom.generated.source.md
@@ -1,10 +1,21 @@
 # RepoM Core Repository Actions
 
-## Configuration
-
-This plugin has no configuration.
-
-This module contains the following methods, variables and/or constants:
+The following actions are part of the core of RepoM and can always be used in your RepositoryActions.
+
+- [`browse-repository@1`](#browse-repository1)
+- [`command@1`](#command1)
+- [`executable@1`](#executable1)
+- [`folder@1`](#folder1)
+- [`foreach@1`](#foreach1)
+- [`git-checkout@1`](#git-checkout1)
+- [`git-fetch@1`](#git-fetch1)
+- [`git-pull@1`](#git-pull1)
+- [`git-push@1`](#git-push1)
+- [`ignore-repository@1`](#ignore-repository1)
+- [`just-text@1`](#just-text1)
+- [`pin-repository@1`](#pin-repository1)
+- [`separator@1`](#separator1)
+- [`url@1`](#url1)
 
 ## browse-repository@1
 
@@ -16,6 +27,11 @@ Properties:
 - `active`: Whether the menu item is enabled. ([Predicate](repository_action_types.md#predicate))
 - `first-only`: Single menu for the first remote. ([Predicate](repository_action_types.md#predicate))
 
+### Example
+
+snippet: browse-repository@1-scenario01
+
+
 ## command@1
 
 Action to excute a command (related to the repository)
@@ -27,6 +43,11 @@ Properties:
 - `command`: The command to execute. ([Text](repository_action_types.md#text))
 - `arguments`: Arguments for the command. ([Text](repository_action_types.md#text))
 
+### Example
+
+snippet: command@1-scenario01
+
+
 ## executable@1
 
 Action to excute an application with additional arguments. This action is almost identical to the `command@1` action. When no existing executables are provided, the action will not show.
@@ -39,6 +60,11 @@ Properties:
 - `arguments`: Arguments for the executable. ([Text](repository_action_types.md#text))
 - `context`: The context in which the action is available. ([Context](repository_action_types.md#context))
 
+### Example
+
+snippet: executable@1-scenario01
+
+
 ## folder@1
 
 Action to create a folder (sub menu) in the context menu of the repository allowing you to order actions.
@@ -50,6 +76,11 @@ Properties:
 - `active`: Whether the menu item is enabled. ([Predicate](repository_action_types.md#predicate))
 - `context`: The context in which the action is available. ([Context](repository_action_types.md#context))
 
+### Example
+
+snippet: folder@1-scenario01
+
+
 ## foreach@1
 
 Action to create repeated actions based on a variable.
@@ -64,6 +95,13 @@ Properties:
 - `skip`: Predicate to skip the current item. ([Predicate](repository_action_types.md#predicate))
 - `actions`: List of repeated actions. (List)
 
+### Example
+
+snippet: foreach@1-scenario01
+
+snippet: foreach@1-scenario02
+
+
 ## git-checkout@1
 
 This action will create a menu and sub menus with all local and remote branches for an easy checkout.
@@ -73,6 +111,11 @@ Properties:
 - `name`: Name of the menu item. ([Text](repository_action_types.md#text))
 - `active`: Whether the menu item is enabled. ([Predicate](repository_action_types.md#predicate))
 
+### Example
+
+snippet: git-checkout@1-scenario01
+
+
 ## git-fetch@1
 
 Action to execute a `git fetch` command.
@@ -82,6 +125,11 @@ Properties:
 - `name`: Name of the menu item. ([Text](repository_action_types.md#text))
 - `active`: Whether the menu item is enabled. ([Predicate](repository_action_types.md#predicate))
 
+### Example
+
+snippet: git-fetch@1-scenario01
+
+
 ## git-pull@1
 
 Action to execute a `git pull` command.
@@ -91,6 +139,11 @@ Properties:
 - `name`: Name of the menu item. ([Text](repository_action_types.md#text))
 - `active`: Whether the menu item is enabled. ([Predicate](repository_action_types.md#predicate))
 
+### Example
+
+snippet: git-pull@1-scenario01
+
+
 ## git-push@1
 
 Action to execute a `git push` command.
@@ -100,6 +153,11 @@ Properties:
 - `name`: Name of the menu item. ([Text](repository_action_types.md#text))
 - `active`: Whether the menu item is enabled. ([Predicate](repository_action_types.md#predicate))
 
+### Example
+
+snippet: git-push@1-scenario01
+
+
 ## ignore-repository@1
 
 Action to ignore the current repository. This repository will be added to the list of ignored repositories and will never show in RepoM.
@@ -111,6 +169,11 @@ Properties:
 - `active`: Whether the menu item is enabled. ([Predicate](repository_action_types.md#predicate))
 - `context`: The context in which the action is available. ([Context](repository_action_types.md#context))
 
+### Example
+
+snippet: ignore-repository@1-scenario01
+
+
 ## just-text@1
 
 Textual action to display some text in the action menu.
@@ -122,6 +185,11 @@ Properties:
 - `enabled`: Show the menu as enabled (clickable) or disabled. ([Predicate](repository_action_types.md#predicate))
 - `context`: The context in which the action is available. ([Context](repository_action_types.md#context))
 
+### Example
+
+snippet: just-text@1-scenario01
+
+
 ## pin-repository@1
 
 Action to pin (or unpin) the current repository. Pinning is not persistant and all pinned repositories will be cleared when RepoM exits.
@@ -134,6 +202,11 @@ Properties:
 - `context`: The context in which the action is available. ([Context](repository_action_types.md#context))
 - `mode`: The pin mode `[Toggle, Pin, UnPin]`. (Nullable, optional)
 
+### Example
+
+snippet: pin-repository@1-scenario01
+
+
 ## separator@1
 
 Creates a visual separator in the action menu.
@@ -143,6 +216,11 @@ Properties:
 - `active`: Whether the menu item is enabled. ([Predicate](repository_action_types.md#predicate))
 - `context`: The context in which the action is available. ([Context](repository_action_types.md#context))
 
+### Example
+
+snippet: separator@1-scenario01
+
+
 ## url@1
 
 Action to open the url in the default browser.
@@ -153,3 +231,8 @@ Properties:
 - `url`: The URL to browse to. ([Text](repository_action_types.md#text))
 - `active`: Whether the menu item is enabled. ([Predicate](repository_action_types.md#predicate))
 - `context`: The context in which the action is available. ([Context](repository_action_types.md#context))
+
+### Example
+
+snippet: url@1-scenario01
+
diff --git a/docs/mdsource/script_variables_file.generated.source.md b/docs/mdsource/script_variables_file.generated.source.md
@@ -1,6 +1,6 @@
 # `file`
 
-Provides file related action menu functions and variables accessable through `file`.
+Provides file related action menu functions and variables accessible through `file`.
 
 This module contains the following methods, variables and/or constants:
 

diff --git a/docs/plugin_repom.plugin.azuredevops.generated.md b/docs/plugin_repom.plugin.azuredevops.generated.md
@@ -28,6 +28,8 @@ To create a PAT, goto `https://dev.azure.com/[my-organisation]/_usersSettings/to
 
 This module contains the following methods, variables and/or constants:
 
+- [`azure-devops-create-pr@1`](#azure-devops-create-pr1)
+
 ## azure-devops-create-pr@1
 
 Action menu item to create a pull request in Azure Devops.

diff --git a/docs/plugin_repom.plugin.clipboard.generated.md b/docs/plugin_repom.plugin.clipboard.generated.md
@@ -10,6 +10,8 @@ This plugin has no configuration.
 
 This module contains the following methods, variables and/or constants:
 
+- [`clipboard-copy@1`](#clipboard-copy1)
+
 ## clipboard-copy@1
 
 This action makes it possible to copy text to the clipboard.

diff --git a/docs/plugin_repom.plugin.sonarcloud.generated.md b/docs/plugin_repom.plugin.sonarcloud.generated.md
@@ -27,6 +27,8 @@ The following default configuration is used:
 
 This module contains the following methods, variables and/or constants:
 
+- [`sonarcloud-set-favorite@1`](#sonarcloud-set-favorite1)
+
 ## sonarcloud-set-favorite@1
 
 Action to mark a repository as favorite within SonarCloud.

diff --git a/docs/plugin_repom.plugin.webbrowser.generated.md b/docs/plugin_repom.plugin.webbrowser.generated.md
@@ -55,6 +55,8 @@ Example configuration:
 
 This module contains the following methods, variables and/or constants:
 
+- [`browser@1`](#browser1)
+
 ## browser@1
 
 Action opening a webbrowser with the provided url.