Skip to content

Comments

chore(docs): general improvements and typos#198

Merged
jbergstroem merged 1 commit intomainfrom
chore/docs-improvements
Jan 27, 2026
Merged

chore(docs): general improvements and typos#198
jbergstroem merged 1 commit intomainfrom
chore/docs-improvements

Conversation

@jbergstroem
Copy link
Owner

Also: address indent issues in usage examples

Also: address indent issues in usage examples
@coderabbitai
Copy link

coderabbitai bot commented Jan 27, 2026

Walkthrough

This pull request updates documentation files with textual and formatting corrections. CONTRIBUTING.md capitalizes "Github" to "GitHub" in release steps. README.md adds License MIT and codecov badges, and corrects capitalization across references to "GitHub" and "GitHub Action" throughout the documentation. USAGE.md adjusts YAML indentation in hadolint step examples and fixes typos and phrasing in prose sections. All changes are documentation-focused with no modifications to code logic, error handling, or execution flow.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore(docs): general improvements and typos' accurately reflects the changeset, which focuses on documentation updates, typo fixes, and formatting corrections across CONTRIBUTING.md, README.md, and USAGE.md.
Description check ✅ Passed The description 'Also: address indent issues in usage examples' is directly related to the changeset, specifically highlighting YAML indentation adjustments in USAGE.md that are part of the broader documentation improvements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

@jbergstroem jbergstroem merged commit b6f3995 into main Jan 27, 2026
9 checks passed
@jbergstroem jbergstroem deleted the chore/docs-improvements branch January 27, 2026 22:58
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