Make I18N Glossary definitions okay in normative blocks
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 84
- Forks
- 69
- Avg merge
- 14h 52m
- Merged PRs (30d)
- 2
Description
I18N encourages the use of the I18N glossary for linking common terminology in specs vs. having to clone the definition locally (with all of the maintenance headaches that ensue). The glossary is published as a NOTE, so is not normative. Uses of this terminology do not generally affect normativity, but linking the terms improves understanding. When the term is used in a normative way, Infra is usually the host to the term and I18N works with WHATWG et al to keep from having any conflicts.
However, this means that references to the I18N glossary produce Respec warnings about “non-normative reference in a normative block”.
(Filing this issue per a conversation with @plehegar, will follow up with PRs)
Contributor guide
No contributing guide indexed for this repository
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 reviewing ReSpec's handling of references to the I18N glossary within normative blocks, along with the Infra terminology referenced in the issue. Identify the relevant reference-validation tests or entry points; done means glossary links no longer produce non-normative-reference warnings when used for terminology in normative content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100