Skip to content

fix: correct leaked spec IDs, stale recipe/workflow counts, and dead doc links - #1083

Merged
norrietaylor merged 4 commits into
mainfrom
inbox-patch/docs-accuracy-fixes-c2341863e3d83bd8
Jul 31, 2026
Merged

fix: correct leaked spec IDs, stale recipe/workflow counts, and dead doc links#1083
norrietaylor merged 4 commits into
mainfrom
inbox-patch/docs-accuracy-fixes-c2341863e3d83bd8

Conversation

@gominimal-aw-bot

@gominimal-aw-bot gominimal-aw-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Caution

Protected files were modified in this change.
This pull request is in request_review mode and requires explicit human scrutiny before merge.

Protected files: AGENTS.md

Fixes #1072
Routing-Key: inbox-route/I_kwDOSUhdos8AAAABKsvK7w

Four documentation accuracy defects, each a localized edit:

  • docs/reference/linux-host-setup.md: replaced the internal deployment-model IDs DM1/DM2/DM3 with functional descriptions — the same class fix: Redact internal spec identifiers (DM1, R4.4) from min --help output #1017 cleaned from min --help but left in the docs (DM1–DM5 are internal networking-spec IDs, informed by G-N7: minvmd supervises exactly one VM; spec says DM1/DM3 support one or more #633).
  • AGENTS.md: the recipe count was stale — just --summary yields 40 recipes on Linux, not 33. The reporter compared macOS's 35 to the stale 33; once corrected the "macOS shows a smaller set" clause holds (35 < 40), so only the number changed.
  • AGENTS.md: bumped the workflow count 11 → 12 and added the missing docs-hotfix table row.
  • docs/reference/minimal-dot-toml.md: removed the two docs.minimal.dev/concepts/{stacks,sessions} links that 404 (sibling concept pages resolve, but no slug is published for these two), keeping the surrounding prose.

Verification

cargo fmt --all --check — clean, no drift
cargo clippy --workspace --locked -- -D warnings — Finished, 0 warnings
cargo build --workspace --locked — Finished dev profile in 4m 26s
cargo test --workspace --locked — all unit suites + doctests ok, 0 failed

Generated by inbox-patch ·

Note

Update AGENTS.md to correct workflow count and document the docs hotfix workflow

Updates AGENTS.md to reflect 12 workflows on main (up from 11) and adds a table entry describing the manual docs hotfix process, which repoints public docs in the gominimal/webapp to a selected main SHA without cutting a binary release.

Macroscope summarized 81f7df3.

Summary by CodeRabbit

  • Documentation
    • Clarified which minimald deployment environments are affected by AppArmor and user namespace restrictions.
    • Simplified configuration reference wording for stack and session settings without changing configuration behavior.
    • Updated repository automation documentation, including workflow and recipe counts and the new documentation hotfix workflow.

Redact the internal deployment-model IDs DM1/DM2/DM3 from the
user-facing linux-host-setup reference, describing the deployments
functionally instead. This follows #1017, which cleaned the same
class from `min --help` but stopped before the docs.

Refresh two stale counts in AGENTS.md: 40 justfile recipes on Linux
(was 33; `just --summary`) and 12 CI workflows (was 11 — the
docs-hotfix workflow was missing from the table).

Drop the two docs.minimal.dev/concepts links (stacks, sessions) that
404, keeping the surrounding prose as plain text; sibling concept
pages resolve but no slug is published for these two.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@gominimal-aw-bot gominimal-aw-bot 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.

Protected files were modified in this pull request and require manual scrutiny before merge.

Please verify that each protected-file change is intentional, policy-compliant, and safe:

  • Protected files: AGENTS.md

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Repository guidance counts and workflow documentation were corrected. Reference documentation was reworded to remove internal deployment identifiers and broken concept links without changing configuration semantics.

Changes

Documentation accuracy

Layer / File(s) Summary
Automation guidance corrections
AGENTS.md
Linux recipe and main workflow counts were updated, and the manual docs-hotfix workflow was added to the CI lane map.
Reference wording corrections
docs/reference/linux-host-setup.md, docs/reference/minimal-dot-toml.md
Deployment wording was generalized, and broken stack/session concept links were replaced with plain text.

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

Possibly related issues

  • gominimal/inbox issue 424: Directly addresses the same four documentation defects in the same files.

Possibly related PRs

Suggested reviewers: twitchyliquid64, msample, 0chroma

Poem

A rabbit hops through docs so bright,
Fixing links by moonlit light.
Counts now match, workflows align,
No secret labels left behind.
Stack and session paths sit true—
A tidy burrow, fresh with dew.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The changes match #1072 by fixing the leaked IDs, stale counts, missing workflow row, and broken docs links.
Out of Scope Changes check ✅ Passed The edits stay within the documentation accuracy fixes described in the linked issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly summarizes the documentation fixes and uses a concise Conventional Commit format.
Description check ✅ Passed The description clearly explains the four fixes and provides verification results, but it omits the template headings and checklist.

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

@norrietaylor
norrietaylor marked this pull request as ready for review July 29, 2026 20:54

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/reference/minimal-dot-toml.md`:
- Around line 126-127: Update the session introduction in the minimal TOML
reference so it is a complete sentence with “[session]” as the subject, while
preserving the existing meaning and continuation about shared primitives.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6e5a4a76-1c45-42c0-b9f2-719b5f273b56

📥 Commits

Reviewing files that changed from the base of the PR and between 4bc6734 and 593b047.

📒 Files selected for processing (3)
  • AGENTS.md
  • docs/reference/linux-host-setup.md
  • docs/reference/minimal-dot-toml.md

Comment thread docs/reference/minimal-dot-toml.md Outdated
Comment on lines 126 to 127
Contributes to sessions activated
on this project (`min session activate`). It carries the same primitives as a

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Make the session introduction a complete sentence.

Contributes to sessions activated... has no subject after the link removal. Use “The [session] section contributes to sessions activated…” to preserve the meaning while keeping the documentation grammatically clear.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/reference/minimal-dot-toml.md` around lines 126 - 127, Update the
session introduction in the minimal TOML reference so it is a complete sentence
with “[session]” as the subject, while preserving the existing meaning and
continuation about shared primitives.

@norrietaylor
norrietaylor requested a review from a team as a code owner July 31, 2026 04:25
@norrietaylor
norrietaylor enabled auto-merge (squash) July 31, 2026 05:12
@norrietaylor
norrietaylor merged commit f7dc233 into main Jul 31, 2026
30 checks passed
@norrietaylor
norrietaylor deleted the inbox-patch/docs-accuracy-fixes-c2341863e3d83bd8 branch July 31, 2026 05:15
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.

docs: leaked DM1/DM2/DM3 spec IDs, two stale counts in AGENTS.md, and two 404 docs.minimal.dev links

1 participant