Skip to content

docs(admin): document growth-report CSV and --mpm options everywhere - #29

Merged
dsblank merged 1 commit into
mainfrom
docs/growth-report-csv-mpm
Oct 1, 2026
Merged

dsblank merged 1 commit into
mainfrom
docs/growth-report-csv-mpm

Conversation

@dsblank

@dsblank dsblank commented Oct 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

Docs follow-up to #27 (CSV export) and #28 (--mpm). README-ADMIN.md was mostly updated in those PRs, but README.md and the --help text weren't.

README.md (growth-report section)

  • Add --csv-dir, --no-html, --chargeback-report to Options; link to the CSV schema in README-ADMIN.md
  • --mpm: "organization admin or a member of every workspace", matching --help
  • Report sections: mention MPM KPIs, MPM models column, MPM leaderboard
  • Fix the stale "MPM is absent" caveat; expand the --mpm caveat (current state only, unknown ≠ zero)
  • Add CSV and MPM examples

README-ADMIN.md

  • Same stale "MPM is absent" caveat
  • --mpm option now agrees with its own caveat
  • --chargeback-report example said "no API call", but service-accounts is still queried

cometx admin growth-report --help

  • Say who counts as an admin (server admin, or org admin on self-hosted; not workspace roles)
  • Output section mentions CSV files, --no-html, --mpm

Test plan

  • cometx admin growth-report --help renders correctly
  • Admin unit tests pass (219)

🤖 Generated with Claude Code

README.md's growth-report section was missing --csv-dir, --no-html and
--chargeback-report, had no CSV/MPM examples, and still said "MPM is
absent". Bring it in line with README-ADMIN.md and --help.

README-ADMIN.md: fix the same stale caveat, make the --mpm option agree
with its caveat (org admin or member of every workspace), and correct the
"no API call" comment on the --chargeback-report example (service-accounts
is still queried).

--help: say who counts as an admin and mention the CSV and --mpm output.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@baz-reviewer

baz-reviewer Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Review this PR on Baz

Baz Summary

Document growth-report CSV export, MPM reporting, and chargeback snapshot options across the main README, admin README, and CLI help. Clarify administrator requirements, MPM completeness and unknown-state caveats, report sections, generated files, and service-account behavior.

Topics

TopicDetails
Growth report docs Document the growth-report workflow, including CSV/HTML output, MPM KPIs and leaderboards, current-state caveats, examples, and chargeback snapshot behavior.
Modified files (2)
  • README-ADMIN.md
  • README.md
Latest Contributors(2)
UserCommitDate
doug@comet.comdocs(admin): document ...October 01, 2026
doug.blank@gmail.com[] MPM presence in gro...October 01, 2026
CLI help updates Clarify growth-report administrator requirements and describe CSV files, --no-html, and --mpm output in CLI help.
Modified files (1)
  • cometx/cli/admin.py
Latest Contributors(2)
UserCommitDate
doug@comet.comdocs(admin): document ...October 01, 2026
doug.blank@gmail.com[] MPM presence in gro...October 01, 2026

Merger  Activate to get a short verdict whether this PR is good to go or not

Skills  Activate Skill Maintainer to keep your skills up to date

Planner  This PR would have been improved with Baz Planner - Try it now

Comment thread README.md
Comment thread README.md
@dsblank
dsblank merged commit 423c4cb into main Oct 1, 2026
2 checks passed
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.

1 participant