Skip to content

docs: README minor improvements - #3111

Open
master-bob wants to merge 2 commits into
celzero:mainfrom
master-bob:patch-1
Open

master-bob wants to merge 2 commits into
celzero:mainfrom
master-bob:patch-1

Conversation

@master-bob

@master-bob master-bob commented Sep 14, 2026

Copy link
Copy Markdown
  • Centers the badges.
  • Sets the certificate SHAs into code blocks, allowing one-click copying

The certifacate SHAs are now one click copyable. Removed the <sub> / <sup> as the rendered spacing looked imbalanced.
@coderabbitai

coderabbitai Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: cb639717-7623-4f10-b67d-4c2ab2ca1b1e

📥 Commits

Reviewing files that changed from the base of the PR and between 69c2cd6 and 5566e15.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.

📜 Recent review details
🧰 Additional context used
🪛 markdownlint-cli2 (0.23.2)
README.md

[warning] 18-18: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

🔇 Additional comments (2)
README.md (2)

5-6: LGTM!

Also applies to: 16-16


20-26: LGTM!


📝 Walkthrough

Walkthrough

The README now centers the app-store badges and formats the Prod and Alpha release certificate SHA-256 digests in fenced text blocks.

Changes

README presentation updates

Layer / File(s) Summary
Badge and digest formatting
README.md
The badge images are wrapped in a centered <div>. The release certificate digests use a heading and fenced text blocks while keeping the same values.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Suggested reviewers: ignoramous

Merge Risk: ⚪ Minimal · up to 5566e

The README-only presentation changes are safe to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately identifies documentation changes to the README. It is broad but remains relevant to the badge alignment and certificate SHA formatting updates.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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