Docs: fix grammar in tutorial intro (Remove redundant adverbs) #755
Conversation
The comparison made with frameworks in a plural form, so we need to add the "s" at the end of framework. The words "also" and "as well" in the same declaration is redundant, so we need to remove the add-on marker "as well" for simplicity. The word "also" might be understood as connecting to the word frameworks, implying other frameworks also run in the browser, which is the opposite of what we are trying to communicate. So I'm suggesting we remove it, keeping the sentence direct.
WalkthroughA grammatical correction to the Elysia tutorial index, fixing punctuation and pluralization in a sentence about Elysia's browser-runtime capability. The phrase was simplified to improve clarity and remove redundancy. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/tutorial/index.md (1)
32-32: Optional follow-up: fix “This playground is will …” typo.
Consider updating to something like “This playground will help you get started…” while you’re here.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/tutorial/index.md(1 hunks)
🔇 Additional comments (1)
docs/tutorial/index.md (1)
34-34: Wording/grammar tweak reads cleaner and unambiguous.
Pluralizing “frameworks” and dropping “also … as well” improves readability without changing meaning.
1 participant
#This PR makes a small wording/grammar improvement in the tutorial intro.
“Unlike traditional backend frameworks, Elysia can run in a browser!”
Rationale: “also … as well” is redundant, and keeping “also” can momentarily read as if it’s modifying “frameworks” (implying other frameworks run in the browser too).
The revised sentence is clearer and more concise without changing meaning.
Even though it’s a small change, this is the very first section new users see in the docs.
Polishing this sentence in the docs helps to fix a first impression to a detailed oriented expectation for people learning the framework.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.