matrix-org / matrix-org/matrix-spec
Improve sample for https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-media-r0-preview-url
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
It should be nice that the sample for URL preview example in https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-media-r0-preview-url include some HTML escaped char, such has `&` or any other one, to avoid implementation bug on clients like https://github.com/vector-im/element-android/issues/2766. The format could also be explicitly defined somewhere in the doc.
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 at the GET /_matrix/media/r0/preview_url section linked in the issue and inspect its URL preview example. Update the sample to include an HTML-escaped character, then document the expected format in the specification so clients can interpret it consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100