docs: document VS Code TypeScript version mismatch for - DOCS UPDATE: #247

[rgved]

Closes #

📝 Description

This pull request updates the project documentation to address a common VS Code
tooling issue where the editor uses an older bundled TypeScript version, resulting
in false-positive tsconfig errors even though the project builds correctly.

The README now clearly explains the issue and provides a workspace-level fix to
ensure VS Code uses the project’s local TypeScript version.

---

🔧 Changes Made

• Added a VS Code TypeScript version notice to the README
• Documented the workspace configuration required to fix the mismatch
• Improved developer setup clarity for new contributors

---

📷 Screenshots or Visual Changes (if applicable)

Not applicable — documentation-only changes.

---

🤝 Collaboration

Collaborated with: (none)

---

✅ Checklist

• I have read the contributing guidelines.
• I have added tests that prove my fix is effective or that my feature works.
  (Not applicable — documentation-only change)
• I have added necessary documentation (if applicable).
• Any dependent changes have been merged and published in downstream modules.

Summary by CodeRabbit

• Documentation
  • Updated README with TypeScript version compatibility notes for VS Code environments.
  • Added step-by-step configuration guidance to resolve TypeScript version conflicts in the editor.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation update to Frontend/README.md replacing ESLint configuration guidance with a TypeScript version compatibility notice for VS Code, including setup instructions to use the workspace TypeScript 5.5+ version.

Changes

Cohort / File(s)	Summary
Documentation Update Frontend/README.md	Replaced "Expanding the ESLint configuration" section with "⚠️ VS Code TypeScript Version Notice" section; added guidance for configuring VS Code to use workspace TypeScript 5.5+ version with step-by-step instructions and JSON configuration snippet; retained recommendation for eslint-plugin-react-x and eslint-plugin-react-dom.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A notice in the README hops,
To fix where bundled TypeScript stops,
Point VS Code the proper way,
Workspace five-five saves the day! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is partially related to the changeset but contains unclear phrasing and formatting issues. It attempts to reference the main change (VS Code TypeScript version documentation) but includes extraneous text ('for -') and a reference format ('DOCS UPDATE: #247') that makes it confusing and not concise.	Revise the title to be more concise and clear, such as 'docs: add VS Code TypeScript version notice' or 'docs: guide for configuring VS Code TypeScript version'. Remove redundant text and reference formatting that obscures the main change.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a3be437 and 636f85e.

📒 Files selected for processing (1)

• Frontend/README.md (2 hunks)

🔇 Additional comments (2)

Frontend/README.md (2)

10-26: Documentation update is clear and well-structured.

The new VS Code TypeScript version notice effectively communicates a common developer pain point with actionable step-by-step instructions. The warning emoji and bold emphasis appropriately draw attention to the issue. The placement after the introductory section makes logical sense for new contributors.

---

19-26: Verify the configuration path works across project setups.

Ensure the "typescript.tsdk": "node_modules/typescript/lib" path is correct for the project's typical structure and that it works when VS Code is opened at different directory levels (e.g., project root vs. Frontend subdirectory).

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Missing closing backticks for JSON code block.

The JSON configuration snippet on line 27 opens a code block with ```json but lacks a closing ```, causing the markdown to render incorrectly. The subsequent JavaScript code block (line 33) will merge with the JSON block visually.

🔎 Proposed fix

   ```json
   {
     "typescript.tsdk": "node_modules/typescript/lib"
   }
+  ```

🤖 Prompt for AI Agents

In Frontend/README.md around lines 27 to 31 the JSON code block starts with
```json but lacks the closing ```; add a closing triple-backtick immediately
after the JSON object (line 31) so the JSON block is properly terminated and the
following JavaScript block renders separately.