Skip to content

Conversation

@nickradford
Copy link
Contributor

@nickradford nickradford commented Feb 6, 2026

Hi Elysia Folks! Love the framework, and wanted to help in a small way by rephrasing some things and fixing some small typos and wording issues.

I know maintaining docs is a ton of work, so these edits are minimal and focused on clarity, not trying to reword things in my voice or anything.

There are also a couple small links that were pointing to the wrong url in the what's next section of the tutorial, so I adjusted those as well.

I focused mainly on the getting started group of docs to keep the scope small. If this direction looks good and the edits are welcome, I'm more than happy to follow up with similar edits in the other sections of the docs over time.

Thanks again for making such an awesome library!

Summary by CodeRabbit

  • Documentation
    • Updated navigation links, menu text and card titles for consistency (pluralized headings)
    • Corrected grammar, spelling, punctuation and phrasing across docs for clarity
    • Fixed internal docs link targets and table-of-contents references
    • Adjusted site docs configuration to align with renamed files and ignore lists
    • Updated code-block labels and corrected a JSON example for accuracy

- at a glance
- quick start
- table of contents
- key concepts

renamed key concepts and table of contents, fixed links to those
thoughout other pages
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 6, 2026

Walkthrough

Renames, grammar fixes and link updates across the docs: singular → plural changes ("Key Concept" → "Key Concepts", "Table of Content" → "Table of Contents"), VitePress navigation edits, minor formatting tidy-ups, and a few internal link/path corrections. No code or API behavior changes.

Changes

Cohort / File(s) Summary
Config & Navigation
docs/.vitepress/config.ts, docs/components/xiao/table-of-content.ts
Updated VitePress config and component links to use table-of-contents, simplified array formatting (llmstxt.ignoreFiles, ssr.noExternal), and adjusted sidebar/navigation text (e.g., "At a Glance" → "At a Glance", "Table of Contents", "Key Concepts").
Top-level docs (titles & copy)
docs/at-glance.md, docs/key-concepts.md, docs/table-of-contents.md
Pluralized titles/headings, corrected grammar/typos, and refined copy for clarity across these pages; no behavior changes.
Tutorials & Guides (link targets)
docs/essential/plugin.md, docs/migrate/index.md, docs/tutorial/getting-started/plugin/index.md, docs/tutorial/whats-next.md
Fixed internal hrefs to point to renamed pages (e.g., key-conceptkey-concepts), adjusted several card hrefs/text (validation, lifecycle, handler, Eden descriptions).
Quick start & examples
docs/quick-start.md
Changed code-block labels from pnpm to bun in two places and fixed JSON syntax in package.json example ("type": "module").

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 I hopped through files with a curious twitch,
Singular to plural — a tidy switch,
Links stitched anew, and grammar made bright,
Docs fluff trimmed down, everything right! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the primary changes: clarifying wording and fixing grammar errors across documentation files, with emphasis on the Getting Started section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/quick-start.md (1)

315-323: ⚠️ Potential issue | 🟠 Major

Invalid JSON in the package.json example — comma instead of colon.

Line 317 has "type", "module" which is invalid JSON (uses a comma instead of a colon). Users copying this example will get a parse error. This appears to be a pre-existing issue that should be fixed while you're editing this file.

✏️ Suggested fix
 {
-	"type", "module",
+	"type": "module",
    	"scripts": {
🤖 Fix all issues with AI agents
In `@docs/migrate/index.md`:
- Line 7: Update the Card component title to use the plural form to match other
files—change the title prop value from "Key Concept (5 minutes)" to "Key
Concepts (5 minutes)" in the Card element (the Card title="Key Concept (5
minutes)" href="/key-concepts") so the displayed title and the href
`/key-concepts` are consistent with config.ts and whats-next.md.

In `@docs/table-of-contents.md`:
- Around line 107-108: Update the sentence "If you feels like exploring more
Elysia features, check out:" in docs/table-of-contents.md to correct
subject–verb agreement by replacing "feels" with "feel" so it reads "If you feel
like exploring more Elysia features, check out:"; locate the exact line
containing that string to apply the change.
- Around line 85-86: Update the ungrammatical recommendation sentence "These are
the core features of Elysia, we highly recommended you to go through these pages
before jumping to other topics:" in docs/table-of-contents.md by fixing tense
and structure; replace it with a correct phrasing such as "These are the core
features of Elysia; we highly recommend that you go through these pages before
jumping to other topics." to locate the text, search for the exact original
sentence string and update it accordingly.

In `@docs/tutorial/getting-started/plugin/index.md`:
- Line 69: Edit the sentence in docs/tutorial/getting-started/plugin/index.md
that currently reads "It's also recommended that you should also read about [Key
Concept: Dependency](/key-concepts#dependency)..." to remove the redundant
"also" so it reads either "It's recommended that you should read about..." or
"It's also recommended that you read about..." (update the exact sentence text
surrounding the link to eliminate the duplicate "also").

In `@docs/tutorial/whats-next.md`:
- Around line 108-112: Update the href on the Lifecycle Card to use the
canonical route: change the Card component instance with title "Lifecycle" so
its href prop is "/essential/life-cycle" instead of "/essential/lifecycle" to
match the documentation's actual page route.
🧹 Nitpick comments (2)
docs/at-glance.md (1)

442-442: Minor grammar nit: "Here's some" → "Here are some".

"Here's" contracts "Here is," which doesn't agree with the plural "resources." This is optional since "Here's some" is widely accepted in informal writing.

✏️ Suggested fix
-Here's some of our community resources to get you started:
+Here are some of our community resources to get you started:
docs/key-concepts.md (1)

40-45: Tighten wording for concision.

Consider trimming the intensifier and “in order to” phrasing for a cleaner sentence.

✂️ Proposed edit
- Elysia has some very important concepts that you need to understand in order to use it effectively.
+ Elysia has important concepts that you need to understand to use it effectively.

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