AkkomaGang/akkoma
AkkomaGang/akkoma
13
63
Fork 84
Code Issues 162 Pull requests 12 Packages Projects 2 Releases 14 Wiki Activity

Document AP and nodeinfo extensions #778

Merged
floatingghost merged 1 commit from Oneric/akkoma:doc_ap-extensions into develop 2024-05-27 01:34:58 +00:00
Conversation 0 Commits 1 Files changed 5 +463 -4
Oneric commented 2024-05-17 00:27:24 +00:00
Member
Copy link

And while add it point to this via a top-level FEDERATION.md document as standardised by FEP-67ff.

I documented all extensions i could think of but it’s possible i missed some.

list scope and listMessage are actually semi-broken atm and afaik basically unused anyway and might be better to remove in a future PR (see #akkoma-dev).

suggestions is hardcoded to false in pleroma/web/nodeinfo/nodeinfo.ex, but changing it to true there still has an effect on akkoma-fe; it will display a “Who to follow” sidebar on the left *(but be stuck in “Loading...”). The v1 version of the suggestions API used to be implemented via third-party recommendations services and more keys with details about the configured service sued to be present, but this got removed in dabd535e43.

And while add it point to this via a top-level `FEDERATION.md` document as standardised by FEP-67ff. I documented all extensions i could think of but it’s possible i missed some. list scope and listMessage are actually semi-broken atm and afaik basically unused anyway and might be better to remove in a future PR *(see `#akkoma-dev`)*. `suggestions` is hardcoded to false in `pleroma/web/nodeinfo/nodeinfo.ex`, but changing it to true there still has an effect on akkoma-fe; it will display a “Who to follow” sidebar on the left *(but be stuck in “Loading...”). The `v1` version of the suggestions API used to be implemented via third-party recommendations services and more keys with details about the configured service sued to be present, but this got removed in dabd535e436789e64f6630460bfadd2f49dcf069.
Oneric added 1 commit 2024-05-17 00:27:24 +00:00
Document AP and nodeinfo extensiosn
Some checks are pending
ci/woodpecker/pr/build-amd64 Pipeline is pending
Details
ci/woodpecker/pr/build-arm64 Pipeline is pending
Details
ci/woodpecker/pr/docs Pipeline is pending
Details
ci/woodpecker/pr/lint Pipeline is pending
Details
ci/woodpecker/pr/test Pipeline is pending
Details
90d1fdb13e 
And while add it point to this via a top-level
FEDERATION.md document as standardised by FEP-67ff.

Also add a few missing descriptions to the config cheatsheet
and move the recently removed C2S extension into an appropiate
subsection.
Oneric changed title from Document AP and nodeinfo extensiosn to Document AP and nodeinfo extensions 2024-05-17 00:27:34 +00:00
Oneric force-pushed doc_ap-extensions from 90d1fdb13e to 35b19aaa37 2024-05-17 00:27:58 +00:00 Compare
Oneric force-pushed doc_ap-extensions from 35b19aaa37 to 60ec13eafa 2024-05-17 00:30:28 +00:00 Compare
Oneric force-pushed doc_ap-extensions from 60ec13eafa to 789bcfabec 2024-05-17 02:42:13 +00:00 Compare
Oneric force-pushed doc_ap-extensions from 789bcfabec to 076529b154 2024-05-17 02:57:17 +00:00 Compare
Oneric force-pushed doc_ap-extensions from 076529b154 to 7272c7a95c 2024-05-25 00:59:48 +00:00 Compare
floatingghost reviewed 2024-05-26 16:37:14 +00:00
floatingghost left a comment
Owner
Copy link

a few little grammar thingies but the docs look very nice

a few little grammar thingies but the docs look very nice
docs/docs/development/ap_extensions.md Outdated
@ -15,0 +84,4 @@
```
!!! note
Albeit an emoji reaction can only contain a single emoji,
floatingghost commented 2024-05-26 16:36:53 +00:00
Owner
Copy link

Albeit -> although

albeit is used exclusively as a conjunction and can't be used in this sort of context

Albeit -> although albeit is used exclusively as a conjunction and can't be used in this sort of context
Oneric commented 2024-05-26 17:08:59 +00:00
Author
Member
Copy link

Thanks for explaining, fixed this and all other comments

Thanks for explaining, fixed this and all other comments
Oneric marked this conversation as resolved
docs/docs/development/ap_extensions.md Outdated
@ -15,0 +235,4 @@
Currently Akkoma, just like Mastodon, only properly supports a single language entry,
in case of multiple entries a random language will be picked.
Furthermore, atm Akkoma will always read the `content` field and
floatingghost commented 2024-05-26 16:33:48 +00:00
Owner
Copy link

i mean i understand it, but the acronym probably shouldn't be here

i mean _i_ understand it, but the acronym probably shouldn't be here
Oneric marked this conversation as resolved
docs/docs/development/ap_extensions.md Outdated
@ -15,0 +256,4 @@
An implementation creating a new post MUST NOT address both the local and
general public scope `as:Public` at the same time. A post addressing the local
scope MUST NOT be sent to other instances or be possible to fetch by other
instances regardless of potential other listed addressants..
floatingghost commented 2024-05-26 16:33:24 +00:00
Owner
Copy link

addressants -> addressees

addressants -> addressees
Oneric marked this conversation as resolved
Oneric force-pushed doc_ap-extensions from 7272c7a95c to 05eda169fe 2024-05-26 17:08:14 +00:00 Compare
floatingghost merged commit cdc918c8f1 into develop 2024-05-27 01:34:58 +00:00
floatingghost deleted branch doc_ap-extensions 2024-05-27 01:34:59 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
approved, awaiting change

   
bug

Something is not working

  
configuration

This requires config changes

  
documentation

This is about human-readable docs

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
extremely low priority

   
feature request

Something new?

  
Fix it yourself

Support has been attempted

  
help wanted

Need some help

  
invalid

Something is wrong

  
mastodon_api

   
needs docs

   
needs tests

   
not a bug

   
planned

   
pleroma_api

   
privacy

   
question

More information is needed

  
static_fe

   
triage

   
wontfix

This won't be fixed

No labels
approved, awaiting change
bug
configuration
documentation
duplicate
enhancement
extremely low priority
feature request
Fix it yourself
help wanted
invalid
mastodon_api
needs docs
needs tests
not a bug
planned
pleroma_api
privacy
question
static_fe
triage
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: AkkomaGang/akkoma#778
No description provided.
Delete branch "Oneric/akkoma:doc_ap-extensions"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?