Commit graph

4 commits

Author SHA1 Message Date
Stephanie Jarmak
749cc63e8d
docs(list): warn that repeated -s/--status silently overwrites (#3916) (#3917)
`bd list --status open --status in_progress` returns only `in_progress`
matches because cobra's StringP flag silently overwrites prior values
on repeat. The canonical multi-status form is the comma-separated
variant (`--status open,in_progress`), and the help text already names
it — but does not warn about the repeated-flag footgun.

Add a one-sentence note to the --status help text and regenerate the
checked-in CLI reference docs via
./scripts/generate-cli-docs.sh. No behavior change.

Closes gastownhall/beads#3916.

Co-authored-by: sjarmak <sjarmak@users.noreply.github.com>
2026-06-22 13:18:44 -07:00
coffeegoddd☕️✨
f783cbbede /{docs,website}: gen docs 2026-06-03 14:30:53 -07:00
Jim Wordelman
70c82c0363 docs(list): regenerate CLI reference for --skip-labels (be-rqm7yb)
CI's "Check doc flags freshness" gate was failing because the new
--skip-labels flag added in this PR wasn't reflected in the generated
CLI reference. Regenerated via ./scripts/generate-cli-docs.sh.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-25 16:26:19 -07:00
matt wilkie
b2a4d1d04a
docs: generate CLI reference from live help (#3704)
* docs: generate CLI reference from live help

* docs(cli): move bd version stamp from per-command pages to index only

Drops the `(bd version X.Y.Z)` suffix from the auto-generated header on
every per-command CLI reference page (writeSingleCommandDoc) and the
docs/CLI_REFERENCE.md preamble (writeAllHelp). The version label now
lives only on the index page emitted by scripts/generate-cli-docs.sh:

- Dev tree (website/docs/cli-reference/index.md, docs/CLI_REFERENCE.md):
  labelled "Latest"
- Versioned snapshots (website/versioned_docs/version-X.Y.Z/...):
  labelled with the explicit semver tag parsed from the directory name

This eliminates the 100+-file no-signal diff a release version bump
otherwise produces, restoring the "regen as a separate small commit"
workflow PR #3704 enables. After this change a version bump alone
yields zero diff on the dev tree; only the new versioned snapshot
created at release-cut time carries the new tag. No datestamps are
introduced anywhere — scripts/generate-cli-docs.sh --check remains
deterministic across CI runs.

Refs: mybd-afb, PR #3704

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: CI Bot <ci@beads.test>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-05 19:43:49 -07:00