Skip to content

docs: point the CI badge at main and label the shell code fences - #9

Merged
DutchyD merged 2 commits into
mainfrom
development
Aug 2, 2026
Merged

docs: point the CI badge at main and label the shell code fences#9
DutchyD merged 2 commits into
mainfrom
development

Conversation

@DutchyD

@DutchyDDutchyD commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Promotes #8 so the corrected badge and fences reach the README on the home page and the published docs site.

Summary by CodeRabbit

  • Documentation
    • Updated the CI status badge to reflect the main branch.
    • Improved syntax highlighting for shell commands in the README and version-resolution documentation.

DutchyDand others added 2 commits August 2, 2026 13:06
The readme rendered on the repository home page is main's readme, so a
badge reporting development described different code than the page it sat
on. It now tracks the branch a visitor actually gets.
Both unlabelled code fences gained a language. Only the one in
version-resolution.md was reported; the readme had the same fence.
docs: point the CI badge at main and label the shell code fences
@coderabbitai

coderabbitaiBot commented Aug 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 588e1ab8-b2f3-454e-b062-4384f672d9d3

📥 Commits

Reviewing files that changed from the base of the PR and between 112405c and 213dd56.

📒 Files selected for processing (2)
  • README.md
  • docs/version-resolution.md

📝 Walkthrough

Walkthrough

The README CI badge now tracks main. Shell command examples in the README and version-resolution documentation now use explicit sh syntax highlighting.

Changes

Documentation references

Layer / File(s)Summary
CI badge branch reference
README.md
The CI badge now references the main branch workflow.
Shell example syntax labels
README.md, docs/version-resolution.md
Shell command code blocks now use explicit sh syntax labels.

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

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly summarizes the CI badge update and shell code-fence labeling changes.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch development

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

@DutchyD
DutchyD merged commit 8b83b05 into mainAug 2, 2026
6 checks passed
Sign up for freeto 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

@DutchyD