Concept documentation
At the moment, there's no clear way to look up different concepts in Funkwhale. With our new specification approach, we should look at making easily searchable and well structured documentation that groups information by concept. For example, you might have a structure like this:
.
└── concepts/
├── artists/
│ └── index.md/
│ ├── create.md
│ ├── delete.md
│ ├── fetch.md
│ └── update.md
└── users/
├── index.md
└── activities/
├── create.md
├── delete.md
├── fetch.md
└── update.md
The information would be catalogued like so:
-
index.md
: overview of the feature including:- What it is and how it appears to end users
- Its ActivityPub representation, if applicable
-
activities/*.md
- Overview of the action and its effects
- The API endpoint specification for the action
- The ActivityPub behavior, if applicable
Information that currently gets written into specs can be represented in these documents where applicable. Since specs may touch multiple different concepts, they should be considered separate.