Skip to content

docs: tone down README marketing copy to sentence case - #223

Merged
brndnmtthws merged 1 commit into
mainfrom
brndnmtthws/docs-readme-tone
Sep 27, 2026
Merged

brndnmtthws merged 1 commit into
mainfrom
brndnmtthws/docs-readme-tone

Conversation

@brndnmtthws

Copy link
Copy Markdown
Owner

Summary

Tones down the README marketing copy: all-caps lead-ins in "Why dryoc?" become sentence case, and hype words ("blazing", "high-performance", "exceptional", "state-of-the-art", "hand-optimized", "Pythonic") are replaced with plain descriptions. Post-Quantum and Platform lead-ins are also sentence-cased for consistency.

User Impact

README reads more neutral and professional; no functional, API, or feature-flag changes.

Root Cause

Marketing-style uppercase labels and superlatives in README prose.

Fix

README.md prose edits only (13 insertions, 13 deletions, no code changes).

Validation

Reviewed git diff --cached; prose-only change, no tests affected.

@netlify

netlify Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for dryoc-docs ready!

Name Link
🔨 Latest commit b24065c
🔍 Latest deploy log https://app.netlify.com/projects/dryoc-docs/deploys/6ab9784693a9a5000871ea86
😎 Deploy Preview https://deploy-preview-223--dryoc-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@brndnmtthws
brndnmtthws marked this pull request as ready for review September 27, 2026 20:10
@brndnmtthws
brndnmtthws enabled auto-merge (squash) September 27, 2026 20:10
@brndnmtthws
brndnmtthws merged commit 445a11f into main Sep 27, 2026
33 checks passed
@brndnmtthws
brndnmtthws deleted the brndnmtthws/docs-readme-tone branch September 27, 2026 20:14
@codecov

codecov Bot commented Sep 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.32%. Comparing base (adb19d0) to head (b24065c).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #223   +/-   ##
=======================================
  Coverage   68.32%   68.32%           
=======================================
  Files         115      115           
  Lines       10032    10032           
=======================================
  Hits         6854     6854           
  Misses       3178     3178           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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