Skip to content

docs: de-dash README prose (modernization)#2

Merged
ascender1729 merged 2 commits into
mainfrom
chore/docs-deslop-modernize
Jun 16, 2026
Merged

docs: de-dash README prose (modernization)#2
ascender1729 merged 2 commits into
mainfrom
chore/docs-deslop-modernize

Conversation

@ascender1729

@ascender1729 ascender1729 commented Jun 16, 2026

Copy link
Copy Markdown
Member

Removes em/en-dashes from README prose (replaced with commas/colons/periods/parentheses). Version refs verified current against Attestix core 0.4.0. Docs-only, no code.

Summary by CodeRabbit

  • Documentation
    • Updated README formatting for improved clarity and readability throughout the documentation.

Prose-only copy cleanup, no code changes. Part of the Attestix cross-repo
modernization pass (em/en-dash removal; version refs verified current).
@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@ascender1729, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 16 minutes and 21 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 008be6eb-cc95-41d0-8203-f00bcf4ffc3d

📥 Commits

Reviewing files that changed from the base of the PR and between 9f9b153 and 2427548.

📒 Files selected for processing (3)
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • SECURITY.md
📝 Walkthrough

Walkthrough

Four punctuation edits in README.md replace em-dashes with parentheses, a comma, and colons in the Offline verifier description, the Verify() sentence, the canonicalization note, and the test-suite verdict list. No functional, API, or behavioral changes.

Changes

README Typography Fixes

Layer / File(s) Summary
README punctuation changes
README.md
Em-dashes replaced: Offline verifier description now uses parentheses; Verify() sentence uses a comma; canonicalization note uses a colon; test-suite VC verify and UCAN chain entries use colons.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through punctuation's maze,
Swapping dashes for colons and commas today,
No em-dash shall linger where a colon can stay,
The README shines brighter in typographic ways,
🐇✨ Neat and tidy — wait, make that: neat and tidy!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: de-dash README prose (modernization)' directly and accurately describes the main change: removing dashes from README documentation. It is concise, clear, and specific.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/docs-deslop-modernize

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.

Community-health files matching the CNCF/OpenSSF standard: Contributor Covenant
2.1 (linked), a language-tailored contributing guide pointing at the shared
conformance vectors, and a coordinated-disclosure security policy.
@ascender1729 ascender1729 merged commit c7dbdf7 into main Jun 16, 2026
6 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