kitlangton / kitlangton/effect-solutions
Documentation Accuracy Issues - 2026-05-15
- Dominant language
- TypeScript
- Stars
- 442
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
## Documentation Accuracy Issues
Automated validation run on 2026-05-15 comparing local docs against upstream source repositories.
---
### `packages/website/docs/01-project-setup.md` — Effect Language Service
**Source:** https://github.com/Effect-TS/language-service/blob/main/README.md
#### [HIGH] `$schema` path uses remote GitHub URL instead of local node_modules path
The local doc instructs users to set:
\`\`\`json
{
"$schema": "https://raw.githubusercontent.com/Effect-TS/language-service/refs/heads/main/schema.json"
}
\`\`\`
The upstream README specifies:
\`\`\`json
{
"$schema": "./node_modules/@effect/language-service/schema.json"
}
\`\`\`
**Why this matters:**
- The GitHub raw URL tracks `main` branch HEAD, which may be ahead of (or structurally incompatible with) the locally installed package version
- Requires internet connectivity for editor schema validation
- Contradicts the upstream recommendation
**Fix:** Replace the `$schema` value with `"./node_modules/@effect/language-service/schema.json"`.
---
*All other documented instructions (installation command, VS Code settings, `prepare` script, editor setup links) are accurate as of this validation run.*
Contributor guide
Research direction
Update packages/website/docs/01-project-setup.md, focusing on the Effect Language Service configuration and its $schema value. Compare the local example with the linked upstream README, then verify that the documented path is the local node_modules schema path and that no other instructions change.
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