mastodon / mastodon/documentation
Make streaming API / websocket information more visible
Open
Nobody has claimed this yet.
API
- Dominant language
- SCSS
- Stars
- 1.7k
- Forks
- 978
- PR merge metrics
- No merged PRs in 30d
Description
Per comments in this issue, the websocket API is currently only really findable via Google search - needs to be surfaced more obviously.
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
Read the streaming WebSocket API page and the linked discussion first. Identify the documentation entry point where this page should be surfaced more visibly; done means users can find the WebSocket API without relying on an external search engine.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100