Skip to content

docs(config): document R1 turn budgets and add a [goal] example - #5996

Open
7jrxt42BxFZo4iAnN4CX wants to merge 2 commits into
Hmbown:mainfrom
7jrxt42BxFZo4iAnN4CX:docs/config-reference-r1-goal
Open

docs(config): document R1 turn budgets and add a [goal] example#5996
7jrxt42BxFZo4iAnN4CX wants to merge 2 commits into
Hmbown:mainfrom
7jrxt42BxFZo4iAnN4CX:docs/config-reference-r1-goal

Conversation

@7jrxt42BxFZo4iAnN4CX

Copy link
Copy Markdown

Summary

[tui].max_model_steps and [tui].turn_wall_clock_secs (the R1 finite turn
budgets) were documented only in config.example.toml comments, not in the
docs/CONFIGURATION.md key reference. Conversely, the [goal] loop was
described in prose in CONFIGURATION.md but had no commented example block in
config.example.toml. This PR closes both gaps so a user can find and set
either knob without reading source.

What changed

  • docs/CONFIGURATION.md: added two bullets to "Core keys" documenting
    tui.max_model_steps (default 200, clamp 1..=100000, 0 = default / no
    unlimited sentinel, ~80% soft landing, exhaustion → Failed after one
    bounded final-report turn, applies to every turn including a single goal
    pass) and tui.turn_wall_clock_secs (default 3600, clamp 30..=86400, human
    approval time excluded, stops before the next billable request). All values
    verified against crates/tui/src/core/engine/turn_budget.rs and
    turn_loop.rs.
  • config.example.toml: added a fully commented # [goal] example block
    (max_continuations default 0 = unlimited, continuation_delay_seconds
    default 0 / cap 86400), matching the "uncomment to enable" style of the file
    and mirroring the Goal loop section of CONFIGURATION.md.

No code changes. No behavior changes. Reviewed against the config reference
and the R1/goal sources across two review iterations (0 Critical/Major
remaining).

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Thanks @7jrxt42BxFZo4iAnN4CX for taking the time to contribute.

This repository is observing a maintainer-managed PR intake gate in dry-run mode, so this pull request is staying open. This note helps maintainers prepare the allowlist before any enforcement is considered.

Please read CONTRIBUTING.md for the expected contribution shape. A maintainer can grant recurring PR access by commenting /lgtm on a pull request.

Hmbown pushed a commit that referenced this pull request Sep 8, 2026
Add providers.openrouter.vendor with strict upstream fallback suppression.
Preserve pins across clients, model switches, config reload boundaries,
auxiliary requests, and the app-server proxy. Preserve caller restrictions.
Capture vendor routing in existing billing, child, and persisted turn receipts;
report routing-dependent unknown cost until vendor-specific pricing exists.
Correct unsupported routing suffix claims and the stale #5996 goal-step docs.

Validation on this isolated d6698f1-based worktree:
- codewhale-config lib: 648 passed, 0 failed, 1 ignored.
- codewhale-protocol lib: 68 passed, 0 failed.
- codewhale-app-server lib: 101 passed, 0 failed.
- codewhale-tui lib vendor filter: 20 passed, 0 failed.
- TUI cost_status: 19 passed; protocol_parity: 5; route_receipt: 6.
  Two cost tests overlap the vendor filter; 48 unique TUI tests passed.
- web npm test: 411 passed; check:docs and check:facts passed.
- cargo fmt --all -- --check and git diff --check passed.
- Requested root npm test and npm run check:web: both failed with Missing
  script because the root package defines neither script. Logs retained.
- Mutation proof: disabling shared vendor serialization caused the gateway
  capture regression to fail (0 passed, 1 failed); exact source restored,
  then the full gateway suite passed 101/101 again.

All request tests use local fixtures. No real provider call, hosted CI,
public push, merge, deployment, tag, or release performed.

Refs #6007, #5996
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants