immersive-web / immersive-web/layers
Spec contains RFC 2119 requirements for authors
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 96
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
Description
The specification contains statements that set requirements on authors using RFC 2119 terms:
- "the author SHOULD populate all the mip levels"
- "The author SHOULD redraw the content of the layer at the next XR animation frame"
- "The author SHOULD fill in the RGB components of this texture..."
The use of RFC 2119 is confusing because authors are not a valid class of products for a specification that is to be implemented by user agents (said differently, authors do not implement W3C specs, the test suite that checks conformance to the specification will not contain tests for these statements). It is certainly useful to include guidelines for authors, but these guidelines can only be informational in nature.
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 by locating the three quoted RFC 2119 statements in the specification and review their surrounding author guidance. Update the author-facing wording so it is informational rather than a conformance requirement, then search the specification for similar RFC 2119 requirements applied to authors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100