mastodon / mastodon/documentation
Add changelog / deprecations page to REST API section
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 1.7k
- Forks
- 978
- PR merge metrics
- No merged PRs in 30d
Description
Currently we don't really have a single page that people can check for deprecations or significant changes, mapped by version, in the documentation. Instead all this information is hidden on each individual endpoint's "version history" section.
By adding this, we can integrate with Deprecation link headers in Mastodon API responses.
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 by locating the REST API documentation section and the endpoint version history sections referenced in the issue. Review how versioned changes and deprecations are currently presented, then add a single page organized by API version; done means readers can find significant changes and deprecations there, including information relevant to deprecation link headers.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100