mastodon / mastodon/documentation
currently undocumented
Open
Nobody has claimed this yet.
API
help wanted
- Dominant language
- SCSS
- Stars
- 1.7k
- Forks
- 978
- PR merge metrics
- No merged PRs in 30d
Description
webhooks
- 4.0.0 admin webhooks https://github.com/mastodon/mastodon/pull/18510
- 4.1.0
account.approvedwebhook https://github.com/mastodon/mastodon/pull/22938 - 4.2.0
report.updatedhttps://github.com/mastodon/mastodon/pull/24211
api
- 4.1.0
hide_collectionsparam on PATCH account/update_credentials https://github.com/mastodon/mastodon/pull/22790 - 4.1.0
roleson Account entity https://github.com/mastodon/mastodon/pull/23255 - 4.1.0
requested_byon Relationship entity https://github.com/mastodon/mastodon/pull/20785 - 4.1.0
policyon WebPushSubscription entity https://github.com/mastodon/mastodon/pull/23210 - 4.1.0
reading:autoplay:gifson api/v1/preferences (but not update_credentials?) https://github.com/mastodon/mastodon/pull/22706/files - 4.1.0 use RoleSerializer for Admin::Account https://github.com/mastodon/mastodon/pull/23290
- 4.1.0 notifications limit raised from 15/30 to 40/80 https://github.com/mastodon/mastodon/pull/23348
- 4.1.0 api rate limit per account 300 -> 1500 (new limit 300 per token) https://github.com/mastodon/mastodon/pull/23347
- 4.1.0 streaming/metrics https://github.com/mastodon/mastodon/pull/23388
- 4.1.0
configuration.urls.statuson api/v2/instance (the changelog is wrong, it claims v1 instead) https://github.com/mastodon/mastodon/pull/23390 - 4.1.0
PUT /api/v1/statuses/:idnow takes an extramedia_attributes[]array parameter with theidof the updated media and their updateddescription,focus, andthumbnailhttps://github.com/mastodon/mastodon/pull/20878 - 4.2
safeguard_mentionsonPOST /api/v1/statuseshttps://github.com/mastodon/mastodon/pull/18350 - 4.2
memorialon Account entity https://github.com/mastodon/mastodon/pull/23591 - 4.2 trends management api https://github.com/mastodon/mastodon/pull/24257
- 4.2 statuses/:id/history now returns at least one item when status is edited (the latest edit, at least) https://github.com/mastodon/mastodon/pull/25510
- 4.2 mark conversation unread https://github.com/mastodon/mastodon/pull/25509
- 4.2
forward_to_domainsonPOST /api/v1/reportshttps://github.com/mastodon/mastodon/pull/25866 - 4.2 api/v1/instance/languages https://github.com/mastodon/mastodon/pull/24443
- 4.2
CredentialAccountentity now includes more params https://github.com/mastodon/mastodon/pull/26998 - 4.3
hide_collectionson Account entity (used to show a different placeholder text) https://github.com/mastodon/mastodon/pull/27791 - 4.3
allow_with_approvalon email_domain_blocks API https://github.com/mastodon/mastodon/pull/28468 - 4.3 Add
api/v1/annual_reportshttps://github.com/mastodon/mastodon/pull/28693 - 4.3 Add
digesttoadmin/domain_blockshttps://github.com/mastodon/mastodon/pull/29092 - 4.3
sourcesproperty on api/v2/suggestions https://github.com/mastodon/mastodon/pull/29108 - 4.3 notification requests and policies https://github.com/mastodon/mastodon/pull/29366
- 4.3 notification policies v2 https://github.com/mastodon/mastodon/pull/31343
- 4.3 api/v1/timelines/link https://github.com/mastodon/mastodon/pull/30381
- 4.3
filteredattribute on notifications https://github.com/mastodon/mastodon/pull/31011 - 4.4 annual reports API https://github.com/mastodon/mastodon/pull/32709
things to test / document
- setting an invalid
in_reply_to_idwhen doingPOST /api/v1/statuseshttps://github.com/mastodon/mastodon/issues/13473
env
- 4.1.0 SIDEKIQ_CONCURRENCY https://github.com/mastodon/mastodon/pull/19589
- 4.1.0 DB_POOL https://github.com/mastodon/mastodon/pull/23470
- 4.1.0 MIN_THREADS https://github.com/mastodon/mastodon/pull/21048
tootctl
- 4.1.0
media removehas new flags https://github.com/mastodon/mastodon/pull/22149 - 4.1.0
accounts deletehas new flags https://github.com/mastodon/mastodon/pull/22328 - 4.1.0
accounts migratehttps://github.com/mastodon/mastodon/pull/22330 - 4.1.0
accounts prunehttps://github.com/mastodon/mastodon/pull/18397 - 4.1.0
domains purgehttps://github.com/mastodon/mastodon/pull/22063 - 4.2 new option for ip_blocks tootctl https://github.com/mastodon/mastodon/pull/24870
- 4.2 tootctl
accounts createhas new flag--approvehttps://github.com/mastodon/mastodon/pull/24533 - 4.2 tootctl
accounts approve --numbersorting was not guaranteed; now it is https://github.com/mastodon/mastodon/pull/24605
???
- 3.3.0 object storage failure now returns 503 in some API methods
-
3.2.0 /api/v1/crypto added but commented out-
4.3.0 removed entirely
-
user guide
- "lock account" is now "require follow requests"
- "list this account on the directory" is now "suggest account to others"
- "hide your network" is now "hide your social graph"
- change order of dropdown menu on posts to be more intuitive in web UI
- change option labels on edit profile page
- change max image dimensions (previously 1280px square, then 1920x1080 unless https://github.com/mastodon/mastodon/pull/23322 is merged, but then https://github.com/mastodon/mastodon/pull/23726 got merged)
- can now upload webp, wave, avif, heic
- custom emoji limit raised from 50kb to 256kb
- authentication history
- automatically delete old posts
- filter search results by author, using
from:syntax - hint about missing media attachment descriptions
- timed mutes
- private boosts
- explore page
- relationship manager
- hashtag normalization
- full text search params
- attribution domains
- lists
admin guide
- figure out what's out of date, if any
- 4.0.0 authorized_fetch tips need to be updated?
- figure out SSO stuff
- install guide - prefer SMTP_TLS over SMTP_ENABLE_STARTTLS? https://github.com/mastodon/mastodon/issues/23180
- OpenID Connect support https://github.com/mastodon/mastodon/pull/16221
project dev guide
client dev guide
technical
- add
CONTRIBUTING.md - note that mf2 (microformats 2) is removed?
- nodeinfo?
- rss?
- clarify stuff around ld sigs
- clarify update_credentials vs preferences (especially when it comes to changing those values via PUT/PATCH) https://github.com/mastodon/documentation/pull/1152
- clarify that ids are not "string representations of numbers" https://github.com/mastodon/mastodon/issues/25244
- 4.2
toot:indexableflag https://github.com/mastodon/mastodon/pull/26485 - 4.2
memorialnow federates astoot:memorialhttps://github.com/mastodon/mastodon/pull/26583
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 unchecked entries under the API, environment, tootctl, user guide, admin guide, and technical sections, using their linked Mastodon pull requests and issues as references. Compare each item with the corresponding current documentation section; done means the relevant changes are documented and the checklist accurately reflects what remains.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, cli, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100