AOSSIE-Org / AOSSIE-Org/InPactAI

DOCS UPDATE:

未關閉
#247 4 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
TypeScript
星號
102
分支
144
PR 合併指標
30 天內沒有已合併 PR

描述

### Is this related to an existing part of the documentation?

- [x] Yes, it is related to an existing section

### What needs to be updated?

## 📌 Current Documentation Issue

The current documentation does not mention a known VS Code tooling issue where the
editor uses its bundled TypeScript version instead of the project’s local version.
This can lead to false-positive TypeScript and `tsconfig` errors in VS Code, even
though the project builds and runs correctly via the terminal.

---

## ✨ Proposed Changes

Add a dedicated section to the README explaining:
- Why the TypeScript version mismatch occurs in VS Code
- How to configure VS Code to use the workspace TypeScript version
- That the issue is tooling-related and does not affect runtime behavior

This improves clarity for contributors and reduces onboarding confusion.

---

## 📋 Additional Context

This issue is commonly observed on Windows systems and Microsoft Store installations
of VS Code, where global settings may be read-only. Using workspace-level settings
consistently resolves the problem and aligns the editor with the project’s tooling.

### Relevant Documentation Link (if any)

https://github.com/AOSSIE-Org/InPactAI/blob/main/README.md

### Record

- [x] I agree to follow this project's Code of Conduct
- [x] I want to work on this update

貢獻指南

這個儲存庫沒有索引到貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。