Skip to content
This repository has been archived by the owner on Mar 29, 2024. It is now read-only.

Aggregate app-specific FEDERATION.md documentation #4

Open
aschrijver opened this issue Mar 31, 2023 · 0 comments
Open

Aggregate app-specific FEDERATION.md documentation #4

aschrijver opened this issue Mar 31, 2023 · 0 comments

Comments

@aschrijver
Copy link

(First posted to the Grassroots Fediverse discussion thread in this comment)

There is a convention for Fediverse Apps to document how they implemented ActivityPub federation. The convention involves adding a FEDERATION.md to the root of the app's codebase, so it is easy to keep up-to-date. A small number of apps are currently following this practice.

With the documentation decentralized like this, there's a bigger likelihood that the documentation is kept up-to-date.

At SocialHub we may investigate a better, more standardized documentation template for FEDERATION.md and maybe even create a FEP for the format.

I started the delightful project at Codeberg (which is similar to awesome-project at GH), and @[email protected] developed the delightful-club project that uses Codeberg CI to aggregate the various curated lists and compile them into the https://delightful.club website. The website auto-builds so that any changes in sub-lists are reflected on the site.

Similar mechanism might be used for fedidocs, based on FEDERATION.md docs it knows about.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant