Skip to content

Commit 13ad620

Browse files
Kasper JungeRalphify
authored andcommitted
docs: add TL;DR and progressive disclosure to cookbook page (category 1)
Collapse helper script details behind expandable blocks so the page is faster to scan. Add TL;DR with anchor links to all 8 recipes. Co-authored-by: Ralphify <noreply@ralphify.co>
1 parent 1228274 commit 13ad620

1 file changed

Lines changed: 19 additions & 14 deletions

File tree

docs/cookbook.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ keywords: ralphify cookbook, autonomous coding recipes, RALPH.md examples, docum
66

77
# Cookbook
88

9+
!!! tldr "TL;DR"
10+
8 copy-pasteable ralph loops: [autoresearch](#autoresearch), [codebase improvement](#codebase-improvement), [documentation](#documentation-loop), [bug hunting](#bug-hunter), [deep research](#deep-research), [code migration](#code-migration), [security scanning](#security-scan), and [test coverage](#test-coverage). Each is a real, runnable example from the `examples/` directory.
11+
912
Copy-pasteable setups for common autonomous workflows. Each recipe is a real, runnable ralph from the [`examples/`](https://github.com/computerlovetech/ralphify/tree/main/examples) directory.
1013

1114
All recipes use **Claude Code** as the agent. To use a different agent, swap the `agent` field — see [Using with Different Agents](agents.md).
@@ -25,19 +28,19 @@ An autonomous ML research loop inspired by [Karpathy's autoresearch](https://git
2528
--8<-- "examples/autoresearch/RALPH.md"
2629
```
2730

28-
The helper scripts surface experiment state each iteration:
31+
??? note "Helper scripts that surface experiment state each iteration"
2932

30-
**`autoresearch/show-results.sh`**
33+
**`autoresearch/show-results.sh`**
3134

32-
```bash
33-
--8<-- "examples/autoresearch/show-results.sh"
34-
```
35+
```bash
36+
--8<-- "examples/autoresearch/show-results.sh"
37+
```
3538

36-
**`autoresearch/show-last-run.sh`**
39+
**`autoresearch/show-last-run.sh`**
3740

38-
```bash
39-
--8<-- "examples/autoresearch/show-last-run.sh"
40-
```
41+
```bash
42+
--8<-- "examples/autoresearch/show-last-run.sh"
43+
```
4144

4245
```bash
4346
ralph run autoresearch --train_script train.py --prepare_script prepare.py
@@ -155,7 +158,8 @@ This is a more advanced ralph — it uses `args` for the research topic, helper
155158
--8<-- "examples/research/RALPH.md"
156159
```
157160

158-
The helper scripts (`show-focus.sh`, `show-questions.sh`, etc.) read from the workspace files and surface key state. The `review.sh` script pipes the full workspace to a separate Claude call that acts as an editorial reviewer — giving the research agent targeted feedback each iteration.
161+
??? note "Helper scripts — `show-focus.sh`, `show-questions.sh`, `review.sh`"
162+
The helper scripts read from the workspace files and surface key state. The `review.sh` script pipes the full workspace to a separate Claude call that acts as an editorial reviewer — giving the research agent targeted feedback each iteration.
159163

160164
```bash
161165
ralph run research --workspace ai-safety --focus "current approaches to AI alignment"
@@ -184,11 +188,12 @@ A loop for batch code transformations — migrating from one pattern to another
184188
--8<-- "examples/migrate/RALPH.md"
185189
```
186190

187-
The `count-remaining.sh` script receives the pattern as an argument (resolved from `{{ args.old_pattern }}` in the `run` field) to find files that still need migration:
191+
??? note "`count-remaining.sh` — tracks migration progress"
192+
The script receives the pattern as an argument (resolved from `{{ args.old_pattern }}` in the `run` field) to find files that still need migration:
188193

189-
```bash
190-
--8<-- "examples/migrate/count-remaining.sh"
191-
```
194+
```bash
195+
--8<-- "examples/migrate/count-remaining.sh"
196+
```
192197

193198
```bash
194199
ralph run migrate --old_pattern "from utils import legacy_helper" \

0 commit comments

Comments
 (0)