kitlangton / kitlangton/effect-solutions

Documentation Accuracy Issues - 2026-04-15

Open Beginner friendly
#38 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
442
Forks
22
PR merge metrics
No merged PRs in 30d

Description

## Documentation Accuracy Issues

Automated validation of `packages/website/docs/01-project-setup.md` against [Effect Language Service README](https://github.com/Effect-TS/language-service/blob/main/README.md).

---

### HIGH: Incorrect `$schema` path in tsconfig.json example

**Local docs instruct:**
\`\`\`json
{
"$schema": "https://raw.githubusercontent.com/Effect-TS/language-service/refs/heads/main/schema.json",
"compilerOptions": { ... }
}
\`\`\`

**Source README specifies:**
\`\`\`json
{
"$schema": "./node_modules/@effect/language-service/schema.json",
"compilerOptions": { ... }
}
\`\`\`

**Why this matters:**
- The remote URL always points to the HEAD of `main`, which may not match the installed package version. If the schema has changed between releases, users get incorrect autocomplete/validation.
- The local path (`./node_modules/...`) reflects the actually-installed version, which is what the source recommends.
- The remote URL requires internet access; the local path works offline.

**Fix:** Replace the remote `$schema` URL with `"./node_modules/@effect/language-service/schema.json"` in the tsconfig example.

---

*Validated by automated documentation accuracy check.*

Contributor guide

Open the contributing guide

Research direction

Update the tsconfig.json example in packages/website/docs/01-project-setup.md, using the Effect Language Service README as the reference. Replace the remote $schema URL with the local node_modules path, then run the repository's automated documentation accuracy check to confirm the example matches the source README.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
92/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.