-
Notifications
You must be signed in to change notification settings - Fork 422
fern: improve grammar on homepage #689
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughThese changes involve correcting grammar, spelling, and textual content across six Vue documentation components. All modifications are refinements to static text content with no impact on logic, functionality, or control flow. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes All changes are homogeneous, repetitive text corrections with no logic modifications. Review requires only visual scanning to verify grammatical accuracy across multiple component files. Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (8)
docs/components/fern/validator.vue (1)
58-61: Polish sentence (combine fragments, drop comma).Reads smoother as one sentence and without the extra comma before “and OpenAPI”.
- With seamless support for type inference, and OpenAPI. You - will feel + With seamless support for type inference and OpenAPI, you'll + feel <span class="text-pink-400 font-medium">right at home</span >.docs/components/fern/beyond.vue (3)
141-144: Tighten grammar (“compile time”/“runtime”).Small tweak for correctness and flow.
- frontend and backend is both type-checked at compile and runtime. + the frontend and backend is type‑checked at both compile time and runtime.
227-231: CSS typo: usewill-change, notwill-move.Modern browsers recognize
will-change;will-moveis ignored.- will-move: left; + will-change: left;
164-172: Preferevent.currentTarget/event.targetoversrcElement.
srcElementis non‑standard. Use standard properties for compatibility.- const element = event.srcElement as HTMLElement + const element = (event.currentTarget as HTMLElement) ?? (event.target as HTMLElement)docs/components/fern/tweets.vue (1)
7-12: Optional a11y: add an accessible name that includes “Elysia”.Visual split is fine, but screen readers will announce only the h2 text. Add an aria-label.
- <h2 - class="text-3xl font-medium text-gray-500 dark:text-gray-300 leading-[3rem]" - v-bind="flyIn()" - > + <h2 + class="text-3xl font-medium text-gray-500 dark:text-gray-300 leading-[3rem]" + v-bind="flyIn()" + aria-label="What people say about Elysia" + > What people say about </h2>docs/components/fern/sponsor.vue (3)
16-20: Microcopy tweak: remove comma and add article for flow.Reads more naturally without the comma and with “the community.”
- <span class="text-gray-700 dark:text-gray-200 font-medium"> - not owned by an organization</span - >, driven by volunteers, and community. + <span class="text-gray-700 dark:text-gray-200 font-medium"> + not owned by an organization</span + >, driven by volunteers and the community.
84-89: Likely condition mismatch: checksilverSponsorslength instead ofsponsors.Parent section already gates on
silverSponsors.length. This inner v-if probably meant the same.- id="sponsors-fern-silver" - v-if="sponsors.length > 0" + id="sponsors-fern-silver" + v-if="silverSponsors.length > 0"
194-198: Vue attribute typo: useclass, notclassName.Otherwise styles won’t apply to this paragraph.
- <p className="text-lg font-semibold text-pink-400 mb-2"> + <p class="text-lg font-semibold text-pink-400 mb-2">
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
docs/components/fern/ask-elysia.vue(1 hunks)docs/components/fern/beyond.vue(2 hunks)docs/components/fern/doc.vue(5 hunks)docs/components/fern/sponsor.vue(2 hunks)docs/components/fern/tweets.vue(1 hunks)docs/components/fern/validator.vue(1 hunks)
🔇 Additional comments (4)
docs/components/fern/beyond.vue (1)
107-110: LGTM: wording fix improves clarity.docs/components/fern/ask-elysia.vue (1)
34-36: LGTM: pluralization is correct.docs/components/fern/sponsor.vue (1)
246-247: LGTM: corrected “supports” → “support”.docs/components/fern/doc.vue (1)
14-14: Excellent grammar corrections!All grammatical improvements are accurate and enhance the documentation quality:
- Subject-verb agreement fixed (integrate → integrates, use → uses, support → supports)
- Proper pluralization applied (type → types, document → documents)
- Correct adjective form used (full-fledge → full-fledged)
- Punctuation corrected (Type Gen. → Type Gen,)
Also applies to: 20-20, 31-31, 65-65, 125-125, 139-139, 143-143
Summary by CodeRabbit