AOSSIE-Org / AOSSIE-Org/InPactAI

DOCS UPDATE:

Ouverte
#247 4 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
Langage dominant
TypeScript
Étoiles
102
Forks
144
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

### 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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.