Skip to content

docs: reconcile harness build command schema - #813

Merged
jtnkminimal merged 1 commit into
mainfrom
amp-codex-5.5-test-366-harness-build-command-docs
Jul 17, 2026
Merged

docs: reconcile harness build command schema#813
jtnkminimal merged 1 commit into
mainfrom
amp-codex-5.5-test-366-harness-build-command-docs

Conversation

@jtnkminimal

@jtnkminimal jtnkminimal commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • replace the nonexistent build_cmds field with build_cmd
  • document build_cmd and build_cmds_cmd as string-or-argv command specifications
  • correct the Nickel examples, code-fence language, and current stack constructor

Verification

  • cargo test -p decode stacks --lib
  • confirmed no stale standalone build_cmds or harness constructor references remain in the document
  • git diff --check

Closes #366

(amp-codex-5.5-test-366-harness-build-command-docs)

Summary by CodeRabbit

  • Documentation
    • Updated the pnpm harness example to use the stack attribute set.
    • Clarified build command configuration with the build_cmd field and its mutually exclusive build_cmds_cmd alternative.
    • Removed outdated nested-array configuration examples and revised related wording.

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a480bf6a-2044-4e2e-ab9d-aa3dc823a78b

📥 Commits

Reviewing files that changed from the base of the PR and between 02ea2f4 and ffadd13.

📒 Files selected for processing (1)
  • docs/reference/harness-specs.md

📝 Walkthrough

Walkthrough

The harness reference updates the pnpm example to use stack and replaces the nonexistent build_cmds documentation with schema-aligned build_cmd and build_cmds_cmd fields.

Changes

Harness specification alignment

Layer / File(s) Summary
Stack examples and build command schema
docs/reference/harness-specs.md
The pnpm example now uses stack; build command documentation defines build_cmd as a string or string array, retains build_cmds_cmd, and documents their mutual exclusivity.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Poem

A rabbit hops through stack today,
While stale build fields fade away.
One command, clear and bright,
Schema-aligned and typed just right—
Docs now bound with carrot delight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: reconciling the harness build-command schema docs.
Linked Issues check ✅ Passed The docs appear to replace build_cmds with build_cmd, retain build_cmds_cmd, and update examples to match the schema.
Out of Scope Changes check ✅ Passed No unrelated changes are evident; the stack example and schema wording support the same documentation reconciliation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Comment @coderabbitai help to get the list of available commands.

@jtnkminimal
jtnkminimal merged commit e5b091f into main Jul 17, 2026
28 checks passed
@jtnkminimal
jtnkminimal deleted the amp-codex-5.5-test-366-harness-build-command-docs branch July 17, 2026 20:52
norrietaylor added a commit that referenced this pull request Jul 18, 2026
…eatures

Audit of docs/reference/ against the code:

- cli.md: Linux installs ship min/mip/minimald only; minvmd is a
  source build (prebuilt amd64 attached to GitHub Releases, no arm64)
  — per scripts/stage-release.sh COMPONENTS and release-pipeline.md.
- minimal-dot-toml.md: rename stale `minimal update`/`minimal
  materialize` to the mip CLI, and cross-reference that `mip update`
  rewrites the upstream and sideload locked_commit fields in place
  (crates/op/src/project/update.rs).
- tasks.md: mip run in the args example; document `description`
  (shown by mip status), the /bin/<cmd> exec resolution, arg defaults
  making arguments optional, and the full arg datatype forms (arrays,
  enums, table form with help/default) per the args crate.
- build-specs.md: replace the line-anchored stdlib blob link with a
  stable file link; tests run by `mip check`.
- harness-specs.md: `mip build` / `mip init` binary names (light
  re-audit after #813).
- sandbox-operations.md: match the in-sandbox helper
  (crates/mctx/src/min_helper.sh + env.rs): --session flag and
  no-flag default, stack.* not harness.* targets, check takes
  --stacks (not --harnesses) and has no --skip-checkers/short flags,
  add the build/test shorthands and patched-pkg, mark the surface
  Linux-only, and add a note disambiguating the helper from the min
  session CLI.
- cli-min.md, cli-mip.md: regenerate the snippets touched by the help
  text fixes (cache clean, login example) from the rebuilt binaries
  at d9f2016.
- crates/minvmd/README.md: replace the stale "persistent data disk is
  a follow-up" note with the shipped per-VM /dev/vdb ext4 volume
  (crates/minvmd/src/volume.rs, spec 08) and update the libkrun
  guidance for the pinned source build (#694), keeping brew as the
  local-dev fallback.
- frontmatter: every reference page now carries title + description.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.

harness-specs.md documents nonexistent build_cmds field; reconcile to stdlib schema

2 participants