Skip to content

Commit c7db239

Browse files
committed
Add some docs fixes
1 parent 29e58ea commit c7db239

7 files changed

Lines changed: 45 additions & 50 deletions

File tree

docs/getting-started/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ brew install uv
2828
```
2929

3030
!!! tip "Why uv?"
31-
`uv` is 10-100x faster than pip for dependency resolution. `uv tool install` creates an isolated environment for CLI tools no virtualenv management needed. If you don't have Python 3.11+ installed, uv can install it for you:
31+
`uv` is 10-100x faster than pip for dependency resolution. `uv tool install` creates an isolated environment for CLI tools - no virtualenv management needed. If you don't have Python 3.11+ installed, uv can install it for you:
3232

3333
```bash
3434
uv python install 3.12
@@ -44,7 +44,7 @@ brew install uv
4444
uv tool install "rlm-code[tui,llm-all]"
4545
```
4646

47-
This installs `rlm-code` as a globally available command in its own isolated environment. No virtualenv activation needed just run `rlm-code` from anywhere.
47+
This installs `rlm-code` as a globally available command in its own isolated environment. No virtualenv activation needed - just run `rlm-code` from anywhere.
4848

4949
=== "uv pip install"
5050

docs/getting-started/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quick Start
22

3-
This guide walks you through launching RLM Code, connecting to an LLM, running your first benchmark, validating results, and exploring the Research tab all in under 10 minutes.
3+
This guide walks you through launching RLM Code, connecting to an LLM, running your first benchmark, validating results, and exploring the Research tab - all in under 10 minutes.
44

55
---
66

docs/index.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<span class="rlm-badge rlm-badge--purple">v0.1.5</span>
1010
<span class="rlm-badge rlm-badge--green">Python 3.11+</span>
11-
<span class="rlm-badge rlm-badge--blue">Apache-2.0</span>
11+
<span class="rlm-badge rlm-badge--blue">Apache 2.0</span>
1212

1313
</div>
1414

@@ -101,39 +101,39 @@ Risk assessment with **40+ rules**, 6 approval modes, and full audit logging to
101101

102102
<div class="rlm-quickstart" markdown>
103103

104-
### Install & Launch
104+
**Install and launch**
105105

106106
```bash
107107
uv tool install "rlm-code[tui,llm-all]"
108108
rlm-code
109109
```
110110

111-
### Connect to a model
111+
**Connect to a model**
112112

113-
```
113+
```text
114114
/connect anthropic claude-opus-4-6
115115
```
116116

117-
### Run your first benchmark
117+
**Run your first benchmark**
118118

119-
```
119+
```text
120120
/rlm bench preset=dspy_quick
121121
```
122122

123-
### Keep runs bounded
123+
**Keep runs bounded**
124124

125-
```
125+
```text
126126
/rlm run "small scoped task" steps=4 timeout=30 budget=60
127127
/rlm abort all
128128
```
129129

130-
### Compare benchmark output
130+
**Compare benchmark output**
131131

132-
```
132+
```text
133133
/rlm bench compare candidate=latest baseline=previous
134134
```
135135

136-
### Switch to the Research tab
136+
**Switch to the Research tab**
137137

138138
Press `Ctrl+5` or `F6` to open the **Research** tab to see your run's dashboard, trajectory, reward curves, and live events.
139139

@@ -181,27 +181,27 @@ graph TB
181181

182182
## 📋 Feature Matrix
183183

184-
| Feature | Status | Module |
185-
|---------|--------|--------|
186-
| 🧠 RLM Runner (multi-paradigm) | | `rlm_code.rlm.runner` |
187-
| 🧪 Pure RLM Environment | | `rlm_code.rlm.pure_rlm_environment` |
188-
| 📡 Event System (27+ types) | | `rlm_code.rlm.events` |
189-
| 🎯 Policy Lab (16 policies) | | `rlm_code.rlm.policies` |
190-
| 🔒 HITL Approval Gates | | `rlm_code.rlm.approval` |
191-
| 📊 Observability (7 sinks) | | `rlm_code.rlm.observability` |
192-
| 🏆 Benchmarks (10 presets) | | `rlm_code.rlm.benchmarks` |
193-
| 📊 Leaderboard | | `rlm_code.rlm.leaderboard` |
194-
| ⏪ Session Replay | | `rlm_code.rlm.session_replay` |
195-
| 🔁 Paradigm Comparison | | `rlm_code.rlm.comparison` |
196-
| 📈 Trajectory Logging | | `rlm_code.rlm.trajectory` |
197-
| 🧹 Memory Compaction | | `rlm_code.rlm.memory_compaction` |
198-
| 📦 6 Sandbox Runtimes | | `rlm_code.sandbox.runtimes` |
199-
| 🤖 12+ LLM Providers | | `rlm_code.models` |
200-
| 🔌 MCP Server | | `rlm_code.mcp` |
201-
| 🖥️ Unified TUI (5 tabs) | | `rlm_code.ui.tui_app` |
202-
| ⌨️ 50+ Slash Commands | | `rlm_code.commands` |
203-
| Code Validation | | `rlm_code.validation` |
204-
| 🧩 Framework Adapters | | `rlm_code.rlm.frameworks` |
184+
| Feature | Module |
185+
|---------|--------|
186+
| 🧠 RLM Runner (multi-paradigm) | `rlm_code.rlm.runner` |
187+
| 🧪 Pure RLM Environment | `rlm_code.rlm.pure_rlm_environment` |
188+
| 📡 Event System (27+ types) | `rlm_code.rlm.events` |
189+
| 🎯 Policy Lab (16 policies) | `rlm_code.rlm.policies` |
190+
| 🔒 HITL Approval Gates | `rlm_code.rlm.approval` |
191+
| 📊 Observability (7 sinks) | `rlm_code.rlm.observability` |
192+
| 🏆 Benchmarks (10 presets) | `rlm_code.rlm.benchmarks` |
193+
| 📊 Leaderboard | `rlm_code.rlm.leaderboard` |
194+
| ⏪ Session Replay | `rlm_code.rlm.session_replay` |
195+
| 🔁 Paradigm Comparison | `rlm_code.rlm.comparison` |
196+
| 📈 Trajectory Logging | `rlm_code.rlm.trajectory` |
197+
| 🧹 Memory Compaction | `rlm_code.rlm.memory_compaction` |
198+
| 📦 6 Sandbox Runtimes | `rlm_code.sandbox.runtimes` |
199+
| 🤖 12+ LLM Providers | `rlm_code.models` |
200+
| 🔌 MCP Server | `rlm_code.mcp` |
201+
| 🖥️ Unified TUI (5 tabs) | `rlm_code.ui.tui_app` |
202+
| ⌨️ 50+ Slash Commands | `rlm_code.commands` |
203+
| Code Validation | `rlm_code.validation` |
204+
| 🧩 Framework Adapters | `rlm_code.rlm.frameworks` |
205205

206206
---
207207

docs/stylesheets/extra.css

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@
167167
}
168168

169169
.rlm-hero-logo {
170-
width: 180px;
170+
width: min(340px, 72vw);
171171
height: auto;
172172
margin-bottom: 0.5em;
173173
filter: drop-shadow(0 0 24px rgba(124, 58, 237, 0.35));
@@ -243,11 +243,6 @@
243243
background: #050510;
244244
}
245245

246-
.rlm-quickstart h3 {
247-
margin-top: 0;
248-
color: #a855f7;
249-
}
250-
251246
/* Badge pills */
252247
.rlm-badge {
253248
display: inline-block;

tests/rlm/test_phase3.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -370,9 +370,9 @@ def test_benchmark_cases_have_pure_rlm_env(self):
370370
for preset in ["oolong_style", "browsecomp_style", "token_efficiency"]:
371371
cases = get_benchmark_cases(preset)
372372
for case in cases:
373-
assert case.environment == "pure_rlm", (
374-
f"{preset}/{case.case_id} should use pure_rlm"
375-
)
373+
assert (
374+
case.environment == "pure_rlm"
375+
), f"{preset}/{case.case_id} should use pure_rlm"
376376

377377
def test_benchmark_cases_have_reasonable_timeouts(self):
378378
"""Test that paper benchmarks have appropriate timeouts."""

tests/test_retry.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ def failing_operation():
8383
with pytest.raises(ValueError):
8484
controller.execute_sync_with_retry(failing_operation, "test_op")
8585

86-
assert attempt_count == max_attempts, (
87-
f"Expected {max_attempts} attempts, got {attempt_count}"
88-
)
86+
assert (
87+
attempt_count == max_attempts
88+
), f"Expected {max_attempts} attempts, got {attempt_count}"
8989

9090
@pytest.mark.asyncio
9191
async def test_async_retry_respects_max_attempts(self):

tests/test_security_validator.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,6 @@ class MockConfig:
209209
validator = SecurityValidator()
210210

211211
# Check module code (where calculator_tool is defined)
212-
assert not validator.has_eval(program.module_code), (
213-
f"Generated module code should not contain eval():\n{program.module_code}"
214-
)
212+
assert not validator.has_eval(
213+
program.module_code
214+
), f"Generated module code should not contain eval():\n{program.module_code}"

0 commit comments

Comments
 (0)