matrix-org / matrix-org/matrix-spec
Appservice registration section includes an unhelpful auto-generated example
Open
Beginner friendly
A-Application-Services
clarification
- 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.6/application-service-api/#registration
**Issue**
The spec talks about YAML files, and even has a hand-crafted example for the registration. The JSON example is not providing value in this section.
Contributor guide
Research direction
Start at the linked application-service registration section and locate its source in the specification repository. Compare the hand-crafted YAML example with the auto-generated JSON example, then verify the rendered section no longer includes the unhelpful JSON example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100