Skip to content

docs(reference): drop the "generated from --help" tagline - #1098

Closed
agent-137 wants to merge 1 commit into
mainfrom
docs/remove-generated-tagline
Closed

docs(reference): drop the "generated from --help" tagline#1098
agent-137 wants to merge 1 commit into
mainfrom
docs/remove-generated-tagline

Conversation

@agent-137

@agent-137 agent-137 commented Jul 30, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Removes the "Generated from --help at <sha>." line from the CLI reference pages for mip, minimald, and minvmd.

Team decision from #frontend: Alyssa asked whether the line should be on the pages, and the thread agreed it shouldn't. Karl approved the change.

There is no generator

The obvious risk here was deleting a line that tooling would reinstate on the next regeneration. It won't — the CLI reference pages are hand-maintained:

  • The string Generated from appears nowhere in the repo outside docs/reference/, in the current tree or anywhere in history (git log --all -S).
  • No doc-generation tooling exists: nothing in crates/, scripts/, the justfile, or .github/workflows/ writes to docs/reference/. The only clap doc-adjacent dependency is clap_complete, which generates shell completions, not markdown.
  • The shas were inconsistent across pages (d9f20165 for mip, 3a05252c for minimald and minvmd, and cb29f065 in cli-min.md before it was removed), which is what hand-written "as of" notes look like, not the output of a single generation pass.
  • cli-min.md already had the line removed by hand in 9c1723e ("Grammar update cli-min.md"), and nothing put it back.

So the fix is the deletion itself; there is no generator to change.

Files touched

  • docs/reference/cli-mip.md
  • docs/reference/cli-minimald.md
  • docs/reference/cli-minvmd.md

Each line was its own paragraph between the intro prose and ## Global flags; the line and one adjacent blank line came out, leaving no double blank lines. cli-min.md needed no change.

#1094 (docs: link concepts pages relatively) is already merged and touches a disjoint set of files (build-specs.md, minimal-dot-toml.md, stack-specs.md, tasks.md), so there is no overlap or rebase needed.

🤖 Generated with Claude Code

https://claude.ai/code/session_01K131eRfYxJ5YdY1v3iMULi

Note

Remove "Generated from --help" tagline from CLI reference docs

Drops the auto-generated attribution line (e.g. Generated from --help at 3a05252c) from cli-minimald.md, cli-minvmd.md, and cli-mip.md.

Macroscope summarized 49b232d.

Summary by CodeRabbit

  • Documentation
    • Removed autogenerated provenance notes from the minimald, minvmd, and mip CLI reference pages.
    • CLI flags, commands, descriptions, and known-issues content remain unchanged.

@mitodrummer @claude
docs(reference): drop the "generated from --help" tagline
49b232d 
The CLI reference pages are hand-maintained, not generated, so the
"Generated from `--help` at `<sha>`." line advertised provenance that
does not exist. The shas were also stale and inconsistent between
pages. cli-min.md already had the line removed by hand; this brings
mip, minimald, and minvmd in line.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01K131eRfYxJ5YdY1v3iMULi
@agent-137
agent-137 requested a review from a team as a code owner July 30, 2026 00:40
@coderabbitai

coderabbitai Bot commented Jul 30, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The CLI reference documentation for minimald, minvmd, and mip removes autogenerated help-provenance metadata lines. All surrounding command and flag documentation remains unchanged.

Changes

CLI reference cleanup

Layer / File(s) Summary
Remove autogenerated provenance lines
docs/reference/cli-*.md		 Removed generated-from-help metadata lines from the three CLI reference documents before their global flags sections.

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

Possibly related issues

  • gominimal/inbox#420 — Directly addresses removing stale Generated from --help provenance stamps.
  • gominimal/minimal#1075 — Concerns removing stale help-generation provenance stamps from CLI reference files.

Possibly related PRs

  • gominimal/minimal#863 — Previously introduced the provenance notes in the same CLI reference documents.

Suggested reviewers: twitchyliquid64

Poem

I nibbled the stamps from each CLI page,
Three docs now turn a cleaner age.
No flags were changed, no commands took flight,
Just provenance gone from plain sight.
Squeak! The references look right.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title is concise and accurately summarizes removing the autogenerated tagline from docs reference pages.
Description check ✅ Passed The description has a clear Summary and rationale, though Testing and Checklist sections from the template are missing.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/remove-generated-tagline

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

@agent-137

agent-137 commented Jul 30, 2026

Copy link
Copy Markdown
Member Author

Closing at Karl's direction: the tagline stays here as provenance for the CLI repo. The webapp (gominimal/webapp) will strip it at docs-sync time instead, alongside the existing renamed-link rewrite, so the published docs lose the line without this repo giving up the provenance marker.

Apologies for the churn, @twitchyliquid64 — thanks for the review.

For the record, the finding that motivated the original change still holds: these reference pages are not generated by anything. Generated from appears nowhere in this repo outside docs/reference/, in the current tree or anywhere in history, and no tooling in crates/, scripts/, the justfile, or .github/workflows/ writes to docs/reference/. The per-page shas were also inconsistent (d9f20165, 3a05252c, and cb29f065 in cli-min.md before 9c1723e removed it by hand). If the line is staying, it is a hand-maintained claim that needs hand-updating.

@agent-137 agent-137 closed this Jul 30, 2026
@agent-137
agent-137 deleted the docs/remove-generated-tagline branch July 30, 2026 00:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@twitchyliquid64 twitchyliquid64 twitchyliquid64 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@agent-137 @twitchyliquid64 @mitodrummer