Skip to content

Commit 698c8ec

Browse files
committed
docs: move doc table to a Documentation section after Quick start
1 parent be463bc commit 698c8ec

1 file changed

Lines changed: 13 additions & 10 deletions

File tree

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,6 @@ You: status?
3232
Ralph: Done — verify passed on attempt 2. Summary is in CONVERSATION.md.
3333
```
3434

35-
| Doc | Start here if you want to… |
36-
|-----|----------|
37-
| [`GETTINGSTARTEDGUIDE.md`](docs/GETTINGSTARTEDGUIDE.md) | **Set it up and run your first loop** (start here) |
38-
| [`INSTALLATION.md`](docs/INSTALLATION.md) | Compare install paths (agent skill, CLI, manual) |
39-
| [`MIGRATION.md`](docs/MIGRATION.md) | Upgrade from the v0.1 plugin |
40-
| [`CHANGELOG.md`](CHANGELOG.md) | See what changed |
41-
| [DeepWiki](https://deepwiki.com/doeixd/opencode-ralph-rlm) | Browse / ask questions about the codebase |
42-
43-
The rest of this README is reference material — tools, config, the management API, and how it works under the hood. New here? Follow the [getting-started guide](docs/GETTINGSTARTEDGUIDE.md) instead, or [ask DeepWiki](https://deepwiki.com/doeixd/opencode-ralph-rlm) anything about the code.
44-
4535

4636
## Quick start
4737

@@ -133,6 +123,19 @@ bun run e2e-smoke -- --spawn
133123
```
134124

135125

126+
## Documentation
127+
128+
| Doc | Start here if you want to… |
129+
|-----|----------|
130+
| [`GETTINGSTARTEDGUIDE.md`](docs/GETTINGSTARTEDGUIDE.md) | **Set it up and run your first loop** (start here) |
131+
| [`INSTALLATION.md`](docs/INSTALLATION.md) | Compare install paths (agent skill, CLI, manual) |
132+
| [`MIGRATION.md`](docs/MIGRATION.md) | Upgrade from the v0.1 plugin |
133+
| [`CHANGELOG.md`](CHANGELOG.md) | See what changed |
134+
| [DeepWiki](https://deepwiki.com/doeixd/opencode-ralph-rlm) | Browse / ask questions about the codebase |
135+
136+
The rest of this README is reference material — tools, config, the management API, and how it works under the hood. New here? Follow the [getting-started guide](docs/GETTINGSTARTEDGUIDE.md) instead, or [ask DeepWiki](https://deepwiki.com/doeixd/opencode-ralph-rlm) anything about the code.
137+
138+
136139
## Plan before the loop
137140

138141
A loop is only as good as its `PLAN.md` — every worker treats it as authority over chat history. The **`interview-and-create-plan`** skill turns a vague goal into an authored plan *before* attempt 1, two ways:

0 commit comments

Comments
 (0)