matrix-org / matrix-org/matrix-spec
Redesign: events
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/unstable/client-server-api/#room-events
**Issue**
There is something off with the presenation here:
The event name, which should be the most visible thing,
- [ ] should not be seperated from its content by a thick black line,
- [ ] should be distinguishable from its content in size and weight,
- [ ] should not be overpowered by table headers and "Content" or "Examples"
I would get rid of the black seperator, and highlight the event name by making it **black and bold** and putting it in a colorful box.
I would de-weight the other parts by indenting, removing vertical whitespace and the blue line at the side of the code block.
---
I hope the solution will look a bit closer to readthedocs:
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 room events section at the linked Matrix Client-Server API page and inspect how its event names, tables, and code blocks are currently presented. Done means event names are visually prominent, while separators, headers, whitespace, and code-block accents no longer overpower the content, matching the requested redesign direction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- design, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100