Skip to content

docs(readme): live badge block + restructure (E5-S05) - #19

Merged
konih merged 2 commits into
mainfrom
lane/e5-s05-readme-badges
Aug 4, 2026
Merged

docs(readme): live badge block + restructure (E5-S05)#19
konih merged 2 commits into
mainfrom
lane/e5-s05-readme-badges

Conversation

@konih

@konih konih commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Restructure README.md: hero + pitch, Quick start, Install, docs links, gate-verified Status.
  • Add badge row for live services only: CI, CodeQL, Scorecard, Docs CI, Documentation (Pages HTTP 200), License, Release, Codecov (90%), Go version, Container (ghcr.io).
  • Sync CHANGELOG.md Unreleased SHAs so changelog:verify matches rebase-merged history (unblocks red CI on main).

Sonar Quality Gate badge — DEFERRED

Not included. SonarCloud alert_status is still ERROR on new_duplicated_lines_density (~4.7%; needs <3%). Per OD-3 revisit (logged in decisions.md), advertising a failing QG is dishonest. Revisit when duplication clears on a post-remediation analysis of main.

Also omitted by prior decisions: pkg.go.dev / Go Reference badge (E5-S07 — meaningful packages are internal/).

Badge verification (pre-PR)

Badge Image HTTP Target HTTP Notes
CI 200 200 workflow live (main was red on changelog drift; this PR syncs it)
CodeQL 200 200 passing
Scorecard 200 200 score 6.1 published
Docs CI 200 200 passing
Documentation 200 200 https://platformrelay.github.io/kollect-render/
License 200 200 MIT
Release 200 200 v0.1.0
Codecov 200 200 90%
Go 200 200 v1.26.5 → go.mod (not pkg.go.dev)
Container 200 200 shields -- hyphen escape; pkgs/container page
Sonar QG deferred (ERROR)

Test plan

  • Every badge image URL resolves (no 404 / no “no status”)
  • Every badge href resolves HTTP 200
  • Pages site HTTP 200
  • task changelog:verify green after sync
  • CI green on this PR

konih added 2 commits August 4, 2026 17:49
Hero + pitch, Quick start, Install, docs links, and gate-verified Status.
Badge row covers live services only; Sonar QG badge deferred while QG is ERROR.
Cliff commit links drifted when PRs landed via rebase-merge; restore verify parity.
@sonarqubecloud

sonarqubecloud Bot commented Aug 4, 2026

Copy link
Copy Markdown

@codecov

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@konih

konih commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

Independent review — APPROVE

Verdict: APPROVE (no P0/P1)

Live-only badges; Sonar QG deferred (QG ERROR); Pages 200; README restructure. Gates green.

@konih
konih merged commit d880138 into main Aug 4, 2026
13 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