docs(bundles): corrected grammar and JSON issues in Bundle docs, and updated the example for consistency #2654
Conversation
…updated the example for consistency
WalkthroughDocumentation improvements to the Data Bundles operations guide, including grammar corrections, active voice rewrites, JSON example formatting fixes, and consistent narrative descriptions for clarity and accuracy. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/operations/bundle.mdx (1)
10-10: Optional: Consider shortening "Prior to" for conciseness.While not part of these changes, the phrase "Prior to Data Bundles" on line 10 could be shortened to "Before Data Bundles" or "Without Data Bundles" for more concise phrasing. This is a minor style suggestion and not required for this PR.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/operations/bundle.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/operations/bundle.mdx
[style] ~9-~9: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...important practice when using Permify. Prior to Data Bundles, it was the responsibility...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
🔇 Additional comments (4)
docs/operations/bundle.mdx (4)
6-6: Grammar corrections improve clarity.The subject-verb agreement fixes ("What are" and "How Bundles Work") are correct and enhance readability.
Also applies to: 16-16
12-12: Active voice rewrites enhance engagement and clarity.The shift from passive construction ("it was the responsibility") to active voice ("you can model", "streamlines managing") makes the documentation more user-focused and highlights the feature's capability more effectively.
Also applies to: 14-14
24-46: JSON formatting fixes improve readability and validity.The restructured JSON now properly wraps the bundle definition in a
bundlesarray and maintains consistent indentation. The format aligns with standard API documentation conventions and is syntactically valid.
18-18: Narrative structure and consistency improved.The added transition sentence (line 18) and clarified result descriptions create a better-structured flow. The example scenario is now clearly explained before and after, with consistent references to bundle names and result items.
Also applies to: 20-20, 51-51, 63-66
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2654 +/- ##
==========================================
- Coverage 82.55% 82.54% -0.01%
==========================================
Files 74 74
Lines 8125 8125
==========================================
- Hits 6707 6706 -1
- Misses 903 904 +1
Partials 515 515 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.