Fix typos and improve clarity in documentation#6282
Fix typos and improve clarity in documentation#6282Shakil-Ahmmed-Dev wants to merge 1 commit intoTanStack:mainfrom
Conversation
📝 WalkthroughWalkthroughThis pull request updates a React documentation file with editorial corrections: capitalizing "Vite" as a proper noun, adding the article "the" for grammatical consistency, and rewording a deployment instruction from "You want to deploy" to "Ready to deploy." Changes
Capitalization of "Vite"; grammatical refinements ("Once the configuration is done"); deployment instruction reworded for active voice. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks✅ Passed checks (3 passed)
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: 1
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/start/framework/react/build-from-scratch.md
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Use relative links to
docs/folder format (e.g.,./guide/data-loading) for internal documentation references
Files:
docs/start/framework/react/build-from-scratch.md
🧠 Learnings (3)
📓 Common learnings
Learnt from: nlynzaad
Repo: TanStack/router PR: 5182
File: e2e/react-router/basic-file-based/src/routes/non-nested/named/$baz_.bar.tsx:3-5
Timestamp: 2025-09-22T00:56:49.237Z
Learning: In TanStack Router, underscores are intentionally stripped from route segments (e.g., `$baz_` becomes `baz` in generated types) but should be preserved in base path segments. This is the correct behavior as of the fix in PR #5182.
📚 Learning: 2025-12-25T13:04:55.492Z
Learnt from: nlynzaad
Repo: TanStack/router PR: 6215
File: e2e/react-start/custom-basepath/package.json:13-17
Timestamp: 2025-12-25T13:04:55.492Z
Learning: In the TanStack Router repository, e2e test scripts are specifically designed to run in CI (which uses a Unix environment), so Unix-specific commands (like `rm -rf`, `&` for backgrounding, and direct environment variable assignments without `cross-env`) are acceptable in e2e test npm scripts.
Applied to files:
docs/start/framework/react/build-from-scratch.md
📚 Learning: 2025-11-02T16:16:24.898Z
Learnt from: nlynzaad
Repo: TanStack/router PR: 5732
File: packages/start-client-core/src/client/hydrateStart.ts:6-9
Timestamp: 2025-11-02T16:16:24.898Z
Learning: In packages/start-client-core/src/client/hydrateStart.ts, the `import/no-duplicates` ESLint disable is necessary for imports from `#tanstack-router-entry` and `#tanstack-start-entry` because both aliases resolve to the same placeholder file (`fake-start-entry.js`) in package.json during static analysis, even though they resolve to different files at runtime.
Applied to files:
docs/start/framework/react/build-from-scratch.md
🔇 Additional comments (1)
docs/start/framework/react/build-from-scratch.md (1)
60-60: Editorial improvements look good.The capitalization of "Vite" as a proper noun and addition of the article "the" improve clarity and grammatical consistency.
Also applies to: 130-130
|
These don't really seem like typo fixes, but more so just rewording things? |
In this commit on docs/start/framework/react/build-from-scratch.md, it can indeed be said as a "wording" fix rather than a "typo" one. Although the previous sentence was not grammatically perfect as well. |
|
please make substantial doc contributions and actually fix typos, not just reword things. |
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.