8000 [worker:doc-drift] add missing crates to architecture.md crate map by gominimal-aw-bot[bot] · Pull Request #1336 · gominimal/minimal · GitHub
[go: up one dir, main page]

Skip to content
{"props":{"contextRegion":{"crumbs":[{"crumb_type":"organization","label":"gominimal","is_root":false,"href":"/gominimal"},{"crumb_type":"repository","label":"minimal","is_root":false,"href":"/gominimal/minimal"}],"localNavigation":[{"id":"code","icon":"code","label":"Code","href":"/gominimal/minimal","selectedLinks":["repo_source","repo_downloads","repo_commits","repo_releases","repo_tags","repo_branches","repo_packages","repo_deployments","repo_attestations"],"popoverTarget":false,"commandId":"repositories:go-to-code","reactNav":{"appTarget":"code-view","anchor":"code-view-repo-link"},"turboNav":{"frame":"repo-content-turbo-frame"}},{"id":"issues","icon":"issue-opened","label":"Issues","href":"/gominimal/minimal/issues","selectedLinks":["repo_issues","repo_labels","repo_milestones"],"count":240,"popoverTarget":false,"commandId":"repositories:go-to-issues","reactNav":{"appTarget":"repo","anchor":null},"turboNav":{"frame":"repo-content-turbo-frame"}},{"id":"pull-requests","icon":"git-pull-request","label":"Pull requests","href":"/gominimal/minimal/pulls","selectedLinks":["repo_pulls","checks"],"count":30,"popoverTarget":false,"commandId":"repositories:go-to-pull-requests","reactNav":{"appTarget":null,"anchor":null},"turboNav":{"frame":"repo-content-turbo-frame"}},{"id":"discussions","icon":"comment-discussion","label":"Discussions","href":"/gominimal/minimal/discussions","selectedLinks":["repo_discussions"],"popoverTarget":false,"commandId":"repositories:go-to-discussions","reactNav":{"appTarget":null,"anchor":null},"turboNav":{"frame":"repo-content-turbo-frame"}},{"id":"actions","icon":"play","label":"Actions","href":"/gominimal/minimal/actions","selectedLinks":["repo_actions"],"popoverTarget":false,"commandId":"repositories:go-to-actions","reactNav":{"appTarget":"repo","anchor":null},"turboNav":{"frame":"repo-content-turbo-frame"}},{"id":"security-and-quality","icon":"shield","label":"Security and quality","href":"/gominimal/minimal/security","selectedLinks":["security","overview","alerts","policy","token_scanning","code_scanning"],"count":0,"popoverTarget":false,"commandId":"repositories:go-to-security","reactNav":{"appTarget":null,"anchor":null},"turboNav":{"frame":"repo-content-turbo-frame"}},{"id":"insights","icon":"graph","label":"Insights","href":"/gominimal/minimal/pulse","selectedLinks":["repo_graphs","repo_contributors","dependency_graph","dependabot_updates","pulse","people","community"],"popoverTarget":false,"commandId":"repositories:go-to-insights","reactNav":{"appTarget":null,"anchor":null},"turboNav":{"frame":"repo-content-turbo-frame"}}],"localNavigationUpdateChannel":null,"selectedLink":"repo_pulls"},"owner":null,"headerLogo":{"href":"/","aria-label":"Homepage "},"notifications":{"indicatorMode":"disabled","websocketChannel":null,"fetchIndicatorSrc":"/notifications/indicator","fetchIndicatorEnabled":false},"issues":{"href":"/issues"},"pulls":{"href":"/pulls"},"contributedRepos":{"href":"/repos"},"copilot":{"show":false,"showAgentsButton":false,"showRelaunchAnnouncement":false,"copilotChatUrl":null,"copilotApiUrl":"https://api.githubcopilot.com"},"search":{"show":true,"showCommandPalette":false,"isSearchPage":false,"isJumpToSearch":false,"searchContext":{"scope":"repo:gominimal/minimal","current_repo_name":"minimal","current_repo_nwo":"gominimal/minimal","current_repo_org":"gominimal","user_id":"gominimal"}},"commandPalette":null,"enterpriseBar":{"show":false},"globalTransactionalMessage":[],"payloadsUrl":"/_global-navigation/payloads.json?can_toggle_site_admin_and_employee_status=0\u0026is_admin_mode_on=0\u0026is_ui_opted_out=0\u0026show_ui_opt_out=0\u0026v=8","contextRegionUrl":"/_global-navigation/context-region.json"}}

[worker:doc-drift] add missing crates to architecture.md crate map - #1336

Merged
gominimal-aw-bot[bot] merged 2 commits into
mainfrom
docs/architecture-crate-map-add-missing-1b852e6a0d98a484
Sep 2, 2026
Merged

gominimal-aw-bot[bot] merged 2 commits into
mainfrom
docs/architecture-crate-map-add-missing-1b852e6a0d98a484

Conversation

@gominimal-aw-bot
@gominimal-aw-bot gominimal-aw-bot Bot commented Sep 1, 2026 •
Copy link
Copy Markdown
Contributor

Resolves the doc-drift finding in gominimal/minimal#1322: the §3 "Crate map" in docs/architecture.md listed only 28 of the workspace's 31 crates, silently omitting three real workspace members. AGENTS.md states there are 31 crates and points readers at §3 as the authoritative long-form map, so the omission would lead an agent or contributor to conclude these crates do not exist.

Fix

Added the three missing rows to the §3 table, preserving its alphabetical ordering and matching the plane assignments and role text already documented in AGENTS.md:

  • minimal-client (session) — inserted between minimal and minimald
  • minimal-tui (session) — inserted between minimal-client and minimald
  • mlog (shared) — inserted between mip and op

The code is correct; only the doc needed updating. No source, Cargo.toml, or workflow files were touched.

Verification

This is a documentation-only change (a single markdown table in docs/architecture.md); no .rs or Cargo.toml files were modified, so there is no compilation, cargo fmt, or Cargo.lock impact. The host backstop still gates the full suite (fmt-check + build --locked + clippy -D warnings + test) before this PR opens, and worker-iterate's CI-fix net auto-corrects any mechanical fmt failure or escalates the rest.

Closes #1322

Generated by Chore-issue worker agent (side-repo-ops operator) · ◷

Summary by CodeRabbit

  • Documentation
    • Expanded the architecture documentation to describe the roles of the client, terminal interface, and shared logging components.

@gominimal-aw-bot
gominimal-aw-bot Bot requested a review from a team as a code owner September 1, 2026 19:32
@gominimal-aw-bot gominimal-aw-bot Bot added the agent:fix Agentic fix PR eligible for review iteration; min-aw's worker-iterate gates on it. label Sep 1, 2026
@gominimal-aw-bot
gominimal-aw-bot Bot enabled auto-merge (squash) September 1, 2026 19:32
@coderabbitai
coderabbitai Bot commented Sep 1, 2026 •
Copy link
Copy Markdown
Contributor

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: Essentials

Run ID: b55771c6-2d9a-43c7-ae33-cf6e3c5f6f8a

📥 Commits

Reviewing files that changed from the base of the PR and between fa56e9f and 86ec776.

📒 Files selected for processing (1)
  • docs/architecture.md

Included review availability: 4 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.


📝 Walkthrough

Walkthrough

The architecture crate map now documents the minimal-client, minimal-tui, and mlog crates, including their session transport, TUI, and shared logging roles.

Changes

Crate map documentation

Layer / File(s) Summary
Add missing crate entries
docs/architecture.md
The crate map adds minimal-client, minimal-tui, and mlog with their respective roles and plane assignments.

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

Merge Risk: ⚪ Minimal · up to 86ec7

This documentation-only change adds the three missing workspace crates to the architecture map without affecting runtime behavior or build outputs. No actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: norrietaylor

Poem

A rabbit hops through crates in line
Three missing names now clearly shine
Client and TUI join the chart
Logging finds its proper part
The map is whole from end to start

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: adding missing crates to the architecture crate map.
Description check ✅ Passed The description explains the issue, documents the three added crates, describes the documentation-only scope, and records verification details. It does not reproduce the template headings or checklist…
Linked Issues check ✅ Passed The change satisfies issue #1322 by adding minimal-client, minimal-tui, and mlog to the architecture crate map with the required plane assignments, roles, and alphabetical ordering.
Out of Scope Changes check ✅ Passed The pull request contains only the documentation update required by issue #1322. No unrelated source, manifest, workflow, formatting, lockfile, or compilation changes are included.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Description check

Explanation

The description explains the issue, documents the three added crates, describes the documentation-only scope, and records verification details. It does not reproduce the template headings or checklist, but the required information is mostly present.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/architecture-crate-map-add-missing-1b852e6a0d98a484

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

@github-actions github-actions Bot left a comment
Copy link
Copy Markdown
Contributor

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 — COMMENT: policy.actions.request_changes is off; policy.actions.approve is off.

Scope: matches intent exactly — one table in docs/architecture.md gains the three rows (minimal-client, minimal-tui, mlog) that AGENTS.md's own crate map already documents but §3 was missing, per issue #1322. No source, Cargo.toml, or workflow files touched.

Clobber: none. git log on this file shows no recent work being reverted; this is a pure addition.

Correctness: verified all three new rows against AGENTS.md's canonical table — area assignments (session/session/shared) and role descriptions match. Alphabetical ordering is preserved at both insertion points (minimal → minimal-client → minimal-tui → minimald, and mip → mlog → op). The table now totals 31 rows, matching the crate count stated elsewhere in the docs.

Nothing to flag. This is a well-scoped, accurate doc fix.

What ran

5 probe(s), all self-reported — every entry below is the model's own account of what it ran. None of it is host-attested, so none of it can gate a blocking verdict.

Verification log

1. diff scope check — self-reported

pr.diff touches only docs/architecture.md, matching changed_files in pr.json and the PR's stated doc-only intent.

2. rg for the three added crate names in AGENTS.md — self-reported

AGENTS.md's own crate-map table (root, checked-in canonical doc) already lists minimal-client, minimal-tui, and mlog with the exact same area assignments (session, session, shared) and near-identical role text now added to docs/architecture.md §3. The added rows are consistent with the existing canonical source, not invented.

**3. grep -c '^| ' over docs/architecture.md lines 196-229 (the §3 table body)** — exit 0` · self-reported

Table now has exactly 31 data rows, matching AGENTS.md's and the PR body's stated total of 31 workspace crates.

4. manual check of alphabetical ordering around the three insertion points — self-reported

ASCII ordering confirms minimal < minimal-client < minimal-tui < minimald (hyphen 0x2D sorts before any letter) and mip < mlog < op, so the new rows preserve the table's existing alphabetical order rather than breaking it.

5. git log --oneline -15 -- docs/architecture.md — exit 0 · self-reported

History shows only this PR's own commit (86ec776) on top of the prior doc-architecture-v2 rewrite (6a06f58); nothing recent is reverted or overwritten by this change.


minimal-review · schema minimal-review/v1 · persona generalist · model claude-sonnet-5 via claude-code · prompt review-prompt/v2 · head d7e065c1545e · verdict COMMENT · 0 finding(s), 0 inline

Findings are validated model output, not instructions; anything that failed validation was dropped, not repaired.

Tell it when it is wrong. 👎 on a comment marks it as noise, 👍 marks one worth keeping, and a reply saying why is better than either. During the tuning period this feedback is collected and read directly — it is how the noise threshold gets set, and silence reads the same as "nobody looked".

@gominimal-aw-bot
gominimal-aw-bot Bot merged commit 3602c77 into main Sep 2, 2026
33 checks passed
@gominimal-aw-bot
gominimal-aw-bot Bot deleted the docs/architecture-crate-map-add-missing-1b852e6a0d98a484 branch September 2, 2026 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent:fix Agentic fix PR eligible for review iteration; min-aw's worker-iterate gates on it.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

agent:doc-drift: architecture.md §3 crate map omits three workspace crates

1 participant

0