Documenting federation behavior in a semi-standard way?

I’m thinking about a FEP formalizing FEDERATION.md file. Here’s how it might look like:

# FEP-67ff: FEDERATION.md

## Summary

`FEDERATION.md` is a file containing information necessary for achieving interoperability with a federated service.

## Requirements

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC-2119](https://tools.ietf.org/html/rfc2119.html).

## Structure

The `FEDERATION.md` file can have arbitrary structure and content. The only requirements are:

- It MUST be a valid Markdown document.
- It MUST be located in the root of a project's code repository. If project's documentation is located in another place, the `FEDERATION.md` file may contain a link to that location.
- It SHOULD include a list of implemented federation protocols.
- It SHOULD include a list of supported Fediverse Enhancement Proposals (FEPs).

## Implementations

- [gathio](https://github.com/lowercasename/gathio/blob/a75aad783c117aaef2ec19b6b434be0f0d7e57de/FEDERATION.md)

What do you think?
@darius Since this was your idea, perhaps you will be interested in submitting such proposal?

2 Likes