diff --git a/README.md b/README.md index aced0cc..56ae8bd 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,12 @@ teams and execute commands in a profile's context. 1. [Getting Started](#getting-started) 2. [About the Project](#about-the-project) -3. [Building the Project](#building-and-using-the-project-locally) -4. [Troubleshooting](#troubleshooting) -5. [Release Process](#release-process) -6. [Contributing](#contributing) -7. [License](#license) +3. [Command Graph](#command-graph) +4. [Building the Project](#building-and-using-the-project-locally) +5. [Troubleshooting](#troubleshooting) +6. [Release Process](#release-process) +7. [Contributing](#contributing) +8. [License](#license) ## Getting Started @@ -83,6 +84,17 @@ content-cli -h content-cli pull package -h ``` +## Command Graph + +[**Open the interactive Command Graph**](https://raw.githack.com/celonis/content-cli/main/docs/command-graph.html) — a +searchable visualization of every Content CLI command, grouped by command area, with descriptions and options shown +on click. It's served live from the [`docs/command-graph.html`](./docs/command-graph.html) source file via +[raw.githack.com](https://raw.githack.com/), so it renders directly in your browser without needing to be downloaded. + +> **Note for contributors:** this graph must be kept in sync manually. See +> [How to Add a Command](./docs/how-to-add-command.md#keeping-the-command-graph-up-to-date) for instructions on +> updating it whenever commands are added or changed. + ## Building and Using the Project locally This tool is tightly connected with the Celonis Platform and all capabilities require to have access to a Celonis Platform Team. diff --git a/docs/command-graph.html b/docs/command-graph.html new file mode 100644 index 0000000..6b43086 --- /dev/null +++ b/docs/command-graph.html @@ -0,0 +1,628 @@ + + + + +content-cli command graph + + + + +
+
+ + +
+
+
root (content-cli)
+
top-level area
+
nested area
+
command
+
deprecated command
+
+ + + + + diff --git a/docs/how-to-add-command.md b/docs/how-to-add-command.md index 4ca1f18..1ef7c51 100644 --- a/docs/how-to-add-command.md +++ b/docs/how-to-add-command.md @@ -157,6 +157,23 @@ You are free to adapt the structure based on complexity. --- +## Keeping the Command Graph Up to Date + +The repository root [README](../README.md#command-graph) links to [`docs/command-graph.html`](./command-graph.html), +an interactive visualization of every Content CLI command and its options. This file is a static, hand-maintained +snapshot — it is **not** generated automatically from the CLI source. + +Whenever you add, remove, rename, deprecate, or change the options/description of a command, update +`docs/command-graph.html` in the same change: + +- Add/update/remove the corresponding entry in the `NODES` array (`id`, `label`, `group`, `path`, `description`, `options`). +- Add/update/remove the corresponding entry in the `EDGES` array to connect the command to its parent area. +- Mark deprecated commands by starting their `description` with `[Deprecated]` — the graph automatically colors these + differently. +- Open the file in a browser afterwards to sanity-check that the new/changed node renders and links correctly. + +--- + ## Useful Examples Example group: [configuration-management](https://github.com/celonis/content-cli/tree/main/src/commands/configuration-management) diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md index 8d365f1..04805f7 100644 --- a/docs/user-guide/index.md +++ b/docs/user-guide/index.md @@ -10,4 +10,3 @@ Content CLI organizes its commands into groups by area. Each group covers a spec | [Asset Registry Commands](./asset-registry-commands.md) | Discover registered asset types and their service descriptors | | [Data Pool Commands](./data-pool-commands.md) | Export and import Data Pools with their dependencies | | [Action Flow Commands](./action-flow-commands.md) | Analyze and export/import Action Flows and their dependencies | -| [Agentic Development](./agentic-development-guide.md) | Discover asset schemas and programmatically create assets using AI agents | diff --git a/mkdocs.yaml b/mkdocs.yaml index f0b07a7..7b0bea3 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -18,7 +18,6 @@ nav: - Asset Registry Commands: './user-guide/asset-registry-commands.md' - Data Pool Commands: './user-guide/data-pool-commands.md' - Action Flow Commands: './user-guide/action-flow-commands.md' - - Agentic Development: './user-guide/agentic-development-guide.md' - Development: - Architecture: './internal-architecture.md' - How to Add a Command: './how-to-add-command.md'