Skip to content

docs: publish badge.json for shields.io (verification badge guide)#208

Open
MohammedAnasNathani wants to merge 1 commit into
alphacrack:mainfrom
MohammedAnasNathani:docs/verification-badge-publish
Open

docs: publish badge.json for shields.io (verification badge guide)#208
MohammedAnasNathani wants to merge 1 commit into
alphacrack:mainfrom
MohammedAnasNathani:docs/verification-badge-publish

Conversation

@MohammedAnasNathani

Copy link
Copy Markdown

Summary

Closes #196 (docs half of #63).

Changes

  • docs/usage.md: add badge.json to Outputs; new Verification badge section with:
    • Verified/unverified JSON shapes from render_badge
    • Route A: orphan readme2demo-badge branch workflow (if: always(), missing-file guard, default-branch push only)
    • Route B: Pages warning (single deployment source)
    • README shields embed snippet
    • Caching caveat (no invented TTLs)
    • Red badge vs no badge table
  • docs/whats-new-0.7.0.md: link the new section

No src/ or .github/workflows/ changes.

Test plan

  • Badge JSON samples generated via render_badge on example manifest
  • mkdocs build --strict if docs extra installed

Add a Verification badge section to usage.md with real badge shapes,
orphan-branch and Pages publish routes, always() rationale, red vs
missing badge behavior, README embed snippet, and a caching caveat.
Link it from the 0.7.0 whats-new note.

Closes alphacrack#196
Copilot AI review requested due to automatic review settings July 22, 2026 20:21

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

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.

docs: publish your run's badge.json so shields.io can render it — workflow snippet + embed markdown (slice of #63)

2 participants