Skip to content

docs(readme): restore Stats section + extra badges (for v0.9.0) - #46

Merged
ffroliva merged 1 commit into
developfrom
docs/readme-restore-badges-stats
May 23, 2026
Merged

ffroliva merged 1 commit into
developfrom
docs/readme-restore-badges-stats

Conversation

@ffroliva

Copy link
Copy Markdown
Owner

Summary

Restore the Stats section and four additional badges that were trimmed in the v0.8.1 README rewrite. The minimalist 5-badge layout that shipped to PyPI for v0.8.1 stays on main; this PR brings the richer version to develop so it ships with the next minor release.

Changes

  • +4 badges below the existing 5 (PyPI / CI / Python / License / Status):
    • Release workflow badge
    • Code style: ruff
    • Type checked: pyright
    • Tests: TDD → links to CONTRIBUTING.md
    • Quality Gate Status (SonarCloud — ffroliva_gflow-cli)
  • + Stats section at the bottom (above the "⭐ the repo" line): GitHub stars, forks, watchers, issues, PRs, last commit, repo size, PyPI downloads.

Both blocks are ported verbatim from the pre-v0.8.1 README. README grew from 116 to 132 lines — still well under the 200-line governance cap.

Test plan

  • scripts/ci/check_doc_links.py — All links resolved across 9 files.
  • CI passes on this PR.
  • Next release (v0.9.0) carries these badges + Stats to PyPI.

Why on develop, not a separate patch release

The badges and Stats are cosmetic / discoverability improvements, not a fix. Per the v0.8.1 release pattern, ship with the next feature release rather than burn another patch number.

@ffroliva
ffroliva merged commit 43c2c43 into develop May 23, 2026
6 checks passed
@ffroliva
ffroliva deleted the docs/readme-restore-badges-stats branch May 23, 2026 21:44
kittinan pushed a commit to kittinan/gflow-cli that referenced this pull request May 30, 2026
Fixes flagged by the 3-agent doc-review council after PR ffroliva#48 (i2v/r2v +
model picker) and PR ffroliva#51 (GFLOW_CLI_LOCALE env override) landed on develop.

Tier 1 — fictional/stale claims removed:

- llms.txt: "video I2V and batch queued for Phase B" was false post-PR ffroliva#48.
  Updated to reflect T2V/I2V/R2V shipped; only `video batch` (manifest
  runner) is still queued, with shell for-loop workaround pointed to.
- PLAN.md: "Issue ffroliva#24 completed in v0.8.1" was false — PR ffroliva#51 landed
  2026-05-24, post-v0.8.1, on develop only. Updated to state Phase 1
  (env override) shipped + live-verified in pt-BR; selector-invariant
  capture still pending. Same correction to Phase 7 checklist.
- KNOWN_ISSUES.md (ffroliva#24): added Progress block noting PR ffroliva#51 + PR ffroliva#48
  changes and the path to dropping `--lang=en-US`.
- LIVE_VERIFICATION_video_download.md: dropped stale "I2V/R2V raise
  NotImplementedError" — they ship in PR ffroliva#48.
- docs/USAGE.md `gflow video batch`: was documenting a full TSV
  manifest as if working; replaced with a not-yet-implemented warning
  and a shell for-loop workaround (separate project_ids per shot).

Tier 2 — important polish:

- GFLOW_CLI_LOCALE documented in `.env.template` and `docs/CONFIGURATION.md`
  (it was code-only after PR ffroliva#51).
- CHANGELOG `[Unreleased] § Added` entry for GFLOW_CLI_LOCALE.
- README + PROJECT_STATUS opening lines reframed: v0.8.1 is the latest
  PyPI release but develop has moved on — added a "develop (unreleased,
  post-v0.8.1)" pointer covering PR ffroliva#37 / ffroliva#46 / ffroliva#48 / ffroliva#51.
- KNOWN_ISSUES Resolved entry for the silent `image --model` no-op
  fixed in PR ffroliva#48 — gives users who hit it on v0.7.0-v0.8.1 a breadcrumb.

All gates pass: doc-link checker (9 files), repo hygiene (255 files), ruff.

Council reports kept locally at tmp/council/0{1,2,3}-*.md (gitignored).

Signed-off-by: Flavio Oliva <ffroliva@gmail.com>
15990166686ll-crypto pushed a commit to 15990166686ll-crypto/gflow-cli that referenced this pull request Aug 24, 2026
…es-stats

docs(readme): restore Stats section + extra badges (for v0.9.0)
15990166686ll-crypto pushed a commit to 15990166686ll-crypto/gflow-cli that referenced this pull request Aug 24, 2026
Fixes flagged by the 3-agent doc-review council after PR ffroliva#48 (i2v/r2v +
model picker) and PR ffroliva#51 (GFLOW_CLI_LOCALE env override) landed on develop.

Tier 1 — fictional/stale claims removed:

- llms.txt: "video I2V and batch queued for Phase B" was false post-PR ffroliva#48.
  Updated to reflect T2V/I2V/R2V shipped; only `video batch` (manifest
  runner) is still queued, with shell for-loop workaround pointed to.
- PLAN.md: "Issue ffroliva#24 completed in v0.8.1" was false — PR ffroliva#51 landed
  2026-05-24, post-v0.8.1, on develop only. Updated to state Phase 1
  (env override) shipped + live-verified in pt-BR; selector-invariant
  capture still pending. Same correction to Phase 7 checklist.
- KNOWN_ISSUES.md (ffroliva#24): added Progress block noting PR ffroliva#51 + PR ffroliva#48
  changes and the path to dropping `--lang=en-US`.
- LIVE_VERIFICATION_video_download.md: dropped stale "I2V/R2V raise
  NotImplementedError" — they ship in PR ffroliva#48.
- docs/USAGE.md `gflow video batch`: was documenting a full TSV
  manifest as if working; replaced with a not-yet-implemented warning
  and a shell for-loop workaround (separate project_ids per shot).

Tier 2 — important polish:

- GFLOW_CLI_LOCALE documented in `.env.template` and `docs/CONFIGURATION.md`
  (it was code-only after PR ffroliva#51).
- CHANGELOG `[Unreleased] § Added` entry for GFLOW_CLI_LOCALE.
- README + PROJECT_STATUS opening lines reframed: v0.8.1 is the latest
  PyPI release but develop has moved on — added a "develop (unreleased,
  post-v0.8.1)" pointer covering PR ffroliva#37 / ffroliva#46 / ffroliva#48 / ffroliva#51.
- KNOWN_ISSUES Resolved entry for the silent `image --model` no-op
  fixed in PR ffroliva#48 — gives users who hit it on v0.7.0-v0.8.1 a breadcrumb.

All gates pass: doc-link checker (9 files), repo hygiene (255 files), ruff.

Council reports kept locally at tmp/council/0{1,2,3}-*.md (gitignored).

Signed-off-by: Flavio Oliva <ffroliva@gmail.com>
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