8000 docs: T137 — Document the one env_vars table in the reference, the guides and the README by minimal-foundry[bot] · Pull Request #3683 · gominimal/minimal · GitHub
[go: up one dir, main page]

Skip to content

docs: T137 — Document the one env_vars table in the reference, the guides and the README - #3683

Merged
mitodrummer merged 3 commits into
mainfrom
agent/3655-document-the-one-env-vars-table-in-the-reference
Nov 20, 2026
Merged

mitodrummer merged 3 commits into
mainfrom
agent/3655-document-the-one-env-vars-table-in-the-reference

Conversation

@minimal-foundry
Copy link
Copy Markdown
Contributor

T137 — Document the one env_vars table in the reference, the guides and the README

slice: S5
kind: enablement
covers: none
size: S
est: 140 code, 60 tests
executor: agent
difficulty: routine
model: light
diagnostics: none: documentation only; the pages name the exit-3 refusal of vars and vars_lenient in words and quote no product text
observability: none: documentation only; nothing runs
layers:
- docs:
- README.md: the loadout example sets [env_vars]
- docs/concepts/loadouts.md: [vars] becomes [env_vars]
- docs/concepts/sessions.md: SHELL is set in [env_vars]
- docs/guide/agents.md: [defaults.session.env_vars]
- docs/guide/dev-shell.md: [defaults.session.env_vars], and a loadout's [env_vars]
- docs/guide/migrate-to-minimal-session.md: profile.env_vars maps to defaults.session.env_vars
- docs/reference/loadouts.md: one [env_vars] section in place of [vars] and [[vars_lenient]], with the name rule and the refusal of the retired keys
- docs/reference/minimal-dot-toml.md: env_vars at every layer, merged by name; the inherit table names env_vars
- docs/reference/tasks.md: env_vars is the task's only variable key, and it merges by name
- check:
- crates/mfile/src/lib.rs: a test that parses each toml example in docs/reference/loadouts.md, minimal-dot-toml.md and tasks.md, and finds no vars or vars_lenient table
test: cargo nextest run -p mfile reference_doc_examples_use_env_vars
produces: none
consumes: none
proof: A person reading the reference, the guides or the README sets variables in env_vars in minimal.toml and in a loadout file, and learns that vars and vars_lenient fail with exit 3.
depends on:
- blocked by #3653

Proof

A person who reads the README, the loadout and session concept pages, the agents, dev-shell and migration guides, or the loadout, minimal.toml and task reference sets variables in env_vars, in minimal.toml at every layer and in a loadout file's [env_vars] table. The minimal.toml reference shows how env_vars merges by name across [defaults], [defaults.], the entry and loadouts. The loadout, minimal.toml and task references say that vars and vars_lenient fail with exit code 3, and give the name rule.

Notes from the agent: The test skips a toml block whose first line is '# user_policy.toml', because the [vars] section of user_policy.toml is a policy section and not a variable layer (tasks.md). A schema sketch with values (the [outputs.] block) is not valid TOML. The test reads its keys line by line, and any other example that does not parse fails the test. I checked that the test fails when a loadout example goes back to [vars]. The [outputs.*] reference now names env_vars for the image variables. The parser still accepts vars there as an alias, and the page no longer mentions that alias. The loadout reference section anchor changed from #vars to #env_vars, and the only link to it (in minimal-dot-toml.md) is updated. The [[vars_lenient]] section is replaced by a 'Retired keys' subsection. I did not run 'just lint-prose' because vale is not installed on this box. 'cargo clippy -p mfile --all-targets' is clean.

Tests

line exit tail
cargo nextest run -p mfile reference_doc_examples_use_env_vars 0 warning: unknown fields in task runtime-implement-test-0: network help: do you need to update to a newer version of minimal? Running task runtime-implement-test-0 in box runtime-implement-test-0-1... Compiling args v0.0.1 (/workbench/crates/args) Compiling ot v0.0.1 (/workbench/crates/ot) C

Verify

min task run agent-verify passed ([tasks.verify]).

Closes #3655

8000
Every layer of minimal.toml and a loadout file sets its variables in one
env_vars table, merged by name. The pages say that vars and vars_lenient
fail with exit code 3, and give the name rule.
The test parses each toml example in the loadout, minimal.toml and task
reference pages, and fails on a vars or vars_lenient key.
@coderabbitai
coderabbitai Bot commented Nov 20, 2026 •
Copy link
Copy Markdown
Contributor

Important

Review skipped

Bot user detected.

Ask an organization administrator to verify that this bot has an active assigned CodeRabbit review seat. See the seat-assignment guide. After the seat is confirmed, request a review again.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 4e231d7a-4a97-4d97-99c5-a7e27669fbed

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

@minimal-foundry
minimal-foundry Bot commented Nov 20, 2026 •
Copy link
Copy Markdown
Contributor Author

Approved: every review thread resolved at 1c1eb28cb725.

@mitodrummer resolved the last thread, which releases the approval this review had withheld.

Nothing to do.

@minimal-foundry minimal-foundry Bot left a comment
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minimal-review — advisory review

Verdict COMMENT — 1 finding, 1 inline.

Panel: 3 of 3 personas ran (correctness, security, supply-chain).

Comment thread crates/mfile/src/lib.rs Resolved
A sketch with <placeholder> values no longer skips the parse. The test fills each placeholder in and
fails on any other toml error.
@minimal-foundry
Copy link
Copy Markdown
Contributor Author

Round 1 of 10 on the runtime's review findings, pushed as 1c1eb28cb725.

line exit tail
cargo nextest run -p mfile reference_doc_examples_use_env_vars 0 warning: unknown fields in task runtime-implement-test-0: network help: do you need to update to a newer version of minimal? Running task runtime-implement-test-0 in box runtime-implement-test-0-1... Compiling args v0.0.1 (/workbench/crates/args) Compiling ot v0.0.1 (/workbench/crates/ot) C

Verify min task run agent-verify passed.

Review threads the coder judged:

  • 👍 valid — crates/mfile/src/lib.rs: The fallback hid a real toml error in a body with '<'. The test now fills in each , requires the result to parse, and checks it with the table walk. The old reader did scan every line, so a key after the error was not missed.

A person reading the reference, the guides or the README sets variables in env_vars in minimal.toml and in a loadout file, and learns that vars and vars_lenient fail with exit 3. The check now also fails on any toml example in the reference pages that does not parse after its values are filled in.

Notes from the agent: Revise round 1: the line-by-line sketch reader is gone. A sketch now parses after each becomes its bare name and each ', ...' list tail is removed. Then the same table walk as the other examples checks it. cargo clippy -p mfile --all-targets printed no warnings.

Commit bodies re-wrapped by the runtime: a prose line over commitlint's 100 is split at a space where no piece is left over it, and code and lines that cannot split are left as written. Every word the coder wrote is kept, in order:

  • test(mfile): require a filled-in schema sketch to parse as toml

@minimal-foundry minimal-foundry Bot left a comment
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minimal-review — approval withheld

Verdict COMMENT — APPROVE withheld: 1 unresolved thread — minimal-foundry[bot] crates/mfile/src/lib.rs. No findings.

Panel: 3 of 3 personas ran (correctness, security, supply-chain).

@agent-137
Copy link
Copy Markdown
Member

/arch-review

1 similar comment
@agent-137
Copy link
Copy Markdown
Member

/arch-review

@minimal-foundry minimal-foundry Bot left a comment
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minimal-review — approved

Verdict APPROVE — every review thread is resolved; @mitodrummer closed the last one. The review of 1c1eb28cb725 withheld this approval on the threads open then. Posted as a comment: the App cannot approve its own pull request; the check and the label carry it.

@minimal-foundry minimal-foundry Bot added the review:approved minimal-review approved the current head label Nov 20, 2026
@mitodrummer
mitodrummer added this pull request to the merge queue Nov 20, 2026
Merged via the queue into main with commit e33e0cb Nov 20, 2026
39 of 40 checks passed
@mitodrummer
mitodrummer deleted the agent/3655-document-the-one-env-vars-table-in-the-reference branch November 20, 2026 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review:approved minimal-review approved the current head

Projects

None yet

Development

Successfully merging this pull request may close these issues.

T137 — Document the one env_vars table in the reference, the guides and the README

2 participants

0