Skip to content

Commit 56d9b1e

Browse files
author
zenus
committed
docs: split bitlesson workflow into dedicated guide
1 parent 8d09179 commit 56d9b1e

3 files changed

Lines changed: 50 additions & 37 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Requires [codex CLI](https://github.com/openai/codex) for review. See the full [
6868
- [Install for Codex](docs/install-for-codex.md) -- Codex skill runtime setup
6969
- [Install for Kimi](docs/install-for-kimi.md) -- Kimi CLI skill setup
7070
- [Configuration](docs/usage.md#configuration) -- Shared config hierarchy and override rules
71-
- [Bitter Lesson Workflow](docs/usage.md#bitlesson-workflow) -- Project memory, selector routing, and delta validation
71+
- [Bitter Lesson Workflow](docs/bitlesson.md) -- Project memory, selector routing, and delta validation
7272

7373
## License
7474

docs/bitlesson.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Bitter Lesson Workflow
2+
3+
BitLesson is the repository's Bitter Lesson-style knowledge capture system for RLCR rounds.
4+
5+
## Configuration
6+
7+
The selector reads `bitlesson_model` from the merged config hierarchy:
8+
9+
1. `config/default_config.json`
10+
2. `~/.config/humanize/config.json`
11+
3. `.humanize/config.json`
12+
4. CLI flags where applicable
13+
14+
Provider routing is automatic:
15+
16+
- `gpt-*`, `o1-*`, `o3-*` route to Codex
17+
- `claude-*`, `haiku`, `sonnet`, `opus` route to Claude
18+
19+
If the configured provider binary is missing, the selector falls back to the default Codex model so the loop can still proceed.
20+
21+
## Workflow
22+
23+
Each project keeps its BitLesson knowledge base at `.humanize/bitlesson.md`.
24+
25+
When `start-rlcr-loop` begins:
26+
27+
1. The file is initialized from `templates/bitlesson.md` if it does not already exist
28+
2. Each task or sub-task runs through `scripts/bitlesson-select.sh`
29+
3. The selected lesson IDs are applied during implementation, or `NONE` is recorded when nothing matches
30+
4. The stop gate validates a required `## BitLesson Delta` section in every round summary
31+
32+
## Summary Contract
33+
34+
Required summary shape:
35+
36+
```markdown
37+
## BitLesson Delta
38+
- Action: none|add|update
39+
- Lesson ID(s): <IDs or NONE>
40+
- Notes: <what changed and why>
41+
```
42+
43+
Validation rules are strict:
44+
45+
- `Action: none` must use `Lesson ID(s): NONE` or leave the field empty
46+
- `Action: add` and `Action: update` must reference concrete `BL-YYYYMMDD-short-name` IDs that exist in `.humanize/bitlesson.md`
47+
- `--require-bitlesson-entry-for-none` can be used to block empty knowledge bases from repeatedly reporting `none`

docs/usage.md

Lines changed: 2 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -180,42 +180,8 @@ Codex model is resolved with this precedence:
180180
`loop_reviewer_model` or `loop_reviewer_effort`, they are silently ignored.
181181
Use `codex_model` and `codex_effort` instead.
182182

183-
### BitLesson Configuration
184-
185-
BitLesson is the repository's Bitter Lesson-style knowledge capture system for RLCR rounds.
186-
187-
The selector reads `bitlesson_model` from the merged config. Provider routing is automatic:
188-
189-
- `gpt-*`, `o1-*`, `o3-*` route to Codex
190-
- `claude-*`, `haiku`, `sonnet`, `opus` route to Claude
191-
192-
If the configured provider binary is missing, the selector falls back to the default Codex model so the loop can still proceed.
193-
194-
## BitLesson Workflow
195-
196-
Each project keeps its BitLesson knowledge base at `.humanize/bitlesson.md`.
197-
198-
When `start-rlcr-loop` begins:
199-
200-
1. The file is initialized from `templates/bitlesson.md` if it does not already exist
201-
2. Each task or sub-task runs through `scripts/bitlesson-select.sh`
202-
3. The selected lesson IDs are applied during implementation, or `NONE` is recorded when nothing matches
203-
4. The stop gate validates a required `## BitLesson Delta` section in every round summary
204-
205-
Required summary shape:
206-
207-
```markdown
208-
## BitLesson Delta
209-
- Action: none|add|update
210-
- Lesson ID(s): <IDs or NONE>
211-
- Notes: <what changed and why>
212-
```
213-
214-
Validation rules are strict:
215-
216-
- `Action: none` must use `Lesson ID(s): NONE` or leave the field empty
217-
- `Action: add` and `Action: update` must reference concrete `BL-YYYYMMDD-short-name` IDs that exist in `.humanize/bitlesson.md`
218-
- `--require-bitlesson-entry-for-none` can be used to block empty knowledge bases from repeatedly reporting `none`
183+
For BitLesson-specific configuration, workflow rules, and summary validation, see
184+
[Bitter Lesson Workflow](bitlesson.md).
219185

220186
## Monitoring
221187

0 commit comments

Comments
 (0)