TL;DR, please check out FEDERATION.md and tell me what you think about it.
Context: I am in the process of federating an existing service for organizing events and meetups called gath.io. The federated currently version lives at events.tinysubversions.com, and the source code for my branch is available here.
Because I’m building a federated service, I felt like I should add the documentation that I wish other federated services had: namely, something that describes how the server responds to and generates ActivityPub activities!
As a first pass, I have created a
FEDERATION.md file that lives in the root of the repo. It is divided into three main sections:
- Federation philosophy
- Inbox behavior
- Activities triggered from the web application
I would like to see other implementations write up something similar to this. Maybe putting it in a FEDERATION.md file in the root could be a de facto standard.
Any thoughts on this? What’s missing that other ActivityPub implementors would like to know about the server? (I’m sure plenty is missing, as I just wrote this up in an hour.)