Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs on pragmatics #28

Open
dahlia opened this issue Mar 31, 2024 · 0 comments
Open

Docs on pragmatics #28

dahlia opened this issue Mar 31, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@dahlia
Copy link
Owner

dahlia commented Mar 31, 2024

While Fedify provides a vocabulary API, it does not provide detailed docs on how to utilize those vocabularies. However, ActivityPub implementations like Mastodon and Misskey already have de facto norms for how to use them, which you should follow to get the desired results.

For example, you need to know which properties on a Person object should be populated with which values to display an avatar or header image, which property represents a date joined, and so on.

We need to have a dedicated reference for this kind of usage of vocabulary.

@dahlia dahlia added the documentation Improvements or additions to documentation label Mar 31, 2024
@dahlia dahlia self-assigned this Mar 31, 2024
@dahlia dahlia changed the title Docs on vocabulary Docs on pragmatics Apr 1, 2024
dahlia added a commit that referenced this issue Apr 1, 2024
@dahlia dahlia removed their assignment Apr 1, 2024
@dahlia dahlia added the help wanted Extra attention is needed label Apr 1, 2024
dahlia added a commit that referenced this issue Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant