[worker:doc-drift] document [stack] as canonical minimal.toml build section - #743
Merged
norrietaylor merged 1 commit intoJul 14, 2026
Merged
Conversation
The minimal.toml schema reference documented the build section only as `[harness]`, but mfile renamed the canonical serde field to `stack`; `harness` is now only a deprecated alias scheduled for removal after July 2026. Rename the section, example, and frontmatter to `[stack]`, keep the `#harness` anchor to preserve inbound links, and note the deprecated alias. Closes #724
📝 WalkthroughWalkthroughThe minimal.toml reference now documents ChangesConfiguration reference
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
Comment |
twitchyliquid64
approved these changes
Jul 14, 2026
This was referenced Jul 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
docs/reference/minimal-dot-toml.mddocumented the build-configuration sectionexclusively as
[harness], but the implementation renamed the canonicalminimal.tomlkey to[stack]. Incrates/mfile/src/lib.rs:617-621the serdefield is
stack, andharnessis only a backward-compatibilityaliasexplicitly scheduled for removal after July 2026:
The doc never mentioned
[stack], so a reader following the reference would keytheir config on a soon-to-be-removed alias and never discover the canonical
name.
Fix
Documentation-only change to
docs/reference/minimal-dot-toml.md:[harness]to[stack].descriptionto liststackinstead ofharness.[harness]is accepted as a deprecated alias for[stack], pending removal after July 2026, so existing configs still resolve.{#harness}heading anchor so existing inbound#harnessdeep linkscontinue to resolve.
Scope is limited to the
[harness]->[stack]rename identified in the issue;no adjacent docs were refactored.
Verification
This is a documentation-only diff — no
.rs,Cargo.toml, orCargo.lockfiles were touched — so no Rust source-compile self-check applies (a markdown
edit does not compile, and the change cannot affect any build/lint/test gate).
The non-bypassable host backstop still gates
cargo fmt --all --check,cargo build --workspace --all-targets --locked,cargo clippy --workspace --all-targets --locked -- -D warnings, andcargo test --workspace --all-targets --lockedbefore this PR opens.Closes #724
Summary by CodeRabbit
[stack]instead of[harness].[harness]as a deprecated alias accepted until after July 2026.[stack]in new configuration files.