diff --git a/README.md b/README.md index 78805bf..9eace8e 100644 --- a/README.md +++ b/README.md @@ -159,7 +159,6 @@ Use `donna --help` for a quick reference. You find detailed documentation in the agent instructions — they are readable and always accurate: -- [Intro](./donna/artifacts/intro.md) — introduction to Donna tool. - [CLI specification](./donna/artifacts/usage/cli.md) — full list of commands and how to use them. - [Artifacts](./donna/artifacts/usage/artifacts.md) — what are Donna artifact and how to use them. - [Worlds](./donna/artifacts/usage/worlds.md) — how Donna discovers and manages its artifacts. @@ -290,7 +289,7 @@ To execute a workflow, Donna uses a simplified virtual machine (VM) that maintai ### Operations -You can find detailed docs on built-in operations in the [artifacts documentation](./donna/artifacts/usage/operations.md). +You can find detailed docs on built-in operations in the [artifacts documentation](./donna/artifacts/usage/artifacts.md). Here is a short list of them: diff --git a/donna/artifacts/usage/artifacts.md b/donna/artifacts/usage/artifacts.md index 08011c2..776d0f7 100644 --- a/donna/artifacts/usage/artifacts.md +++ b/donna/artifacts/usage/artifacts.md @@ -170,7 +170,9 @@ kind = "donna.lib.request_action" #### Kinds of Workflow Operations -1. `donna.lib.request_action` operation kind indicates that Donna will request the agent to perform some action. +##### `donna.lib.request_action` + +`donna.lib.request_action` operation kind indicates that Donna will request the agent to perform some action. The content of the tail section is the text instructions for the agent on what to do. @@ -188,7 +190,9 @@ Here may be any additional instructions, requirements, notes, references, etc. **The body of the operation MUST contain a neat strictly defined algorithm for the agent to follow.** -2. `donna.lib.run_script` operation kind executes a script from the operation body without agent/user interaction. +##### `donna.lib.run_script` + +`donna.lib.run_script` operation kind executes a script from the operation body without agent/user interaction. The body of the operation MUST include exactly one fenced code block whose info string includes ` donna script`. Any other text in the operation body is ignored. @@ -229,7 +233,9 @@ Routing rules: When `save_stdout_to` and/or `save_stderr_to` are set, the operation stores captured output in the task context under the specified variable names. -3. `donna.lib.output` operation kind emits its body as an output cell and then continues to the configured next step. +##### `donna.lib.output` + +`donna.lib.output` operation kind emits its body as an output cell and then continues to the configured next step. The body of the operation is rendered as an output cell during execution. @@ -241,7 +247,9 @@ kind = "donna.lib.output" next_operation_id = "" # required ``` -4. `donna.lib.finish` operation kind indicates that the workflow is finished. +##### `donna.lib.finish` + +`donna.lib.finish` operation kind indicates that the workflow is finished. The body of the operation is rendered as an output cell before the workflow completes.