matrix-org / matrix-org/matrix-spec
ABNF blocks clearly inherit from each other, but we don't say that they do
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Link to problem area**:
* https://spec.matrix.org/v1.7/appendices/#server-name
* https://spec.matrix.org/v1.7/appendices/#user-identifiers
* https://spec.matrix.org/v1.7/appendices/#historical-user-ids
* https://spec.matrix.org/v1.7/appendices/#matrix-uri-scheme
**Issue**
For example, our grammar for user IDs uses `server_name`, which is defined in another section.
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 comparing the ABNF blocks in the linked server-name, user-identifiers, historical-user-ids, and Matrix URI scheme sections. Clarify the relationships between grammar definitions in the specification, with the work complete when readers can see which blocks inherit or depend on definitions from other sections.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100