We should clarify the document scope in the Introduction section
Open
Nobody has claimed this yet.
for next iteration
priority: low
Spec-improvement
- Dominant language
- HTML
- Stars
- 45
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Description
- The document is mainly informative.
- The document presents some algorithms that are language-agnostic, implementations may or should use them notwithstanding which is their language
- Some of the API, even if it is described using WebIDL may be very close to TypeScript and in general imply browser technologies that may be not present on other platforms in that specific shape.
- If there are discrepancies or API holes that are more glaring in other languages they should be reported and they will be addressed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Introduction section referenced by the issue and review its existing scope statement. Clarify that the document is mainly informative, that algorithms are language-agnostic, and that WebIDL and TypeScript-like APIs may reflect browser technologies. Done means these scope limits and the process for reporting gaps in other languages are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100