matrix-org / matrix-org/matrix-spec
Make block widths consistent
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
From https://github.com/matrix-org/matrix-doc/pull/2959#issuecomment-762636762:
Block widths are all over the place. Text blocks have one standard width, code blocks are wider, tables are sometimes wider, sometimes narrower than text, and so on. See section 12.11.1.6 for an example, where the two parameter tables (EncryptedFile and JWK) have different widths even though they are adjacent to each other. This sticks out like a sore thumb when scrolling through the document.
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 section 12.11.1.6, especially the adjacent EncryptedFile and JWK parameter tables, and inspect how the specification renders text, code, and table blocks. No source file or test is named; done means the relevant block types use consistent widths and the cited tables no longer differ visibly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100