Skip to content

Commit 4478b97

Browse files
authored
Docs structure fixes (#49)
1 parent cc5ede0 commit 4478b97

2 files changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,6 @@ Use `donna --help` for a quick reference.
159159

160160
You find detailed documentation in the agent instructions — they are readable and always accurate:
161161

162-
- [Intro](./donna/artifacts/intro.md) — introduction to Donna tool.
163162
- [CLI specification](./donna/artifacts/usage/cli.md) — full list of commands and how to use them.
164163
- [Artifacts](./donna/artifacts/usage/artifacts.md) — what are Donna artifact and how to use them.
165164
- [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
290289

291290
### Operations
292291

293-
You can find detailed docs on built-in operations in the [artifacts documentation](./donna/artifacts/usage/operations.md).
292+
You can find detailed docs on built-in operations in the [artifacts documentation](./donna/artifacts/usage/artifacts.md).
294293

295294
Here is a short list of them:
296295

donna/artifacts/usage/artifacts.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,9 @@ kind = "donna.lib.request_action"
170170

171171
#### Kinds of Workflow Operations
172172

173-
1. `donna.lib.request_action` operation kind indicates that Donna will request the agent to perform some action.
173+
##### `donna.lib.request_action`
174+
175+
`donna.lib.request_action` operation kind indicates that Donna will request the agent to perform some action.
174176

175177
The content of the tail section is the text instructions for the agent on what to do.
176178

@@ -188,7 +190,9 @@ Here may be any additional instructions, requirements, notes, references, etc.
188190

189191
**The body of the operation MUST contain a neat strictly defined algorithm for the agent to follow.**
190192

191-
2. `donna.lib.run_script` operation kind executes a script from the operation body without agent/user interaction.
193+
##### `donna.lib.run_script`
194+
195+
`donna.lib.run_script` operation kind executes a script from the operation body without agent/user interaction.
192196

193197
The body of the operation MUST include exactly one fenced code block whose info string includes `<language> donna script`.
194198
Any other text in the operation body is ignored.
@@ -229,7 +233,9 @@ Routing rules:
229233
When `save_stdout_to` and/or `save_stderr_to` are set, the operation stores captured output in the task context
230234
under the specified variable names.
231235

232-
3. `donna.lib.output` operation kind emits its body as an output cell and then continues to the configured next step.
236+
##### `donna.lib.output`
237+
238+
`donna.lib.output` operation kind emits its body as an output cell and then continues to the configured next step.
233239

234240
The body of the operation is rendered as an output cell during execution.
235241

@@ -241,7 +247,9 @@ kind = "donna.lib.output"
241247
next_operation_id = "<next_operation_id>" # required
242248
```
243249

244-
4. `donna.lib.finish` operation kind indicates that the workflow is finished.
250+
##### `donna.lib.finish`
251+
252+
`donna.lib.finish` operation kind indicates that the workflow is finished.
245253

246254
The body of the operation is rendered as an output cell before the workflow completes.
247255

0 commit comments

Comments
 (0)