diff options
| author |  tsmethurst <tobi.smethurst@klarrio.com> | 2021-03-01 11:52:49 +0100 |
|---|---|---|
| committer | tsmethurst <tobi.smethurst@klarrio.com> | 2021-03-01 11:52:49 +0100 |
| commit | bffbdeb5347d5d72ec43a46750cbe35f75699893 (patch) | |
| tree | 0fb1527f967698575a9a6c96c22c0133fd44e7b7 /docs/pages/api | |
| parent | Doc updates (diff) | |
| download | gotosocial-bffbdeb5347d5d72ec43a46750cbe35f75699893.tar.xz | |
try some doc changes
Diffstat (limited to 'docs/pages/api')
| -rw-r--r-- | docs/pages/api/activitypub.rst | 4 | ||||
| -rw-r--r-- | docs/pages/api/client.rst | 4 | ||||
| -rw-r--r-- | docs/pages/api/index.rst | 13 | ||||
| -rw-r--r-- | docs/pages/api/internal.rst | 4 |
4 files changed, 25 insertions, 0 deletions
diff --git a/docs/pages/api/activitypub.rst b/docs/pages/api/activitypub.rst new file mode 100644 index 000000000..fd47c7ef3 --- /dev/null +++ b/docs/pages/api/activitypub.rst @@ -0,0 +1,4 @@ +ActivityPub / Federation +------------------------ + +This document describes the API used for federating with other ActivityPub instances. diff --git a/docs/pages/api/client.rst b/docs/pages/api/client.rst new file mode 100644 index 000000000..c74f5887f --- /dev/null +++ b/docs/pages/api/client.rst @@ -0,0 +1,4 @@ +Client APIs +----------- + +This document describes the client APIs exposed by GoToSocial to the outside world. diff --git a/docs/pages/api/index.rst b/docs/pages/api/index.rst new file mode 100644 index 000000000..b41c49b7a --- /dev/null +++ b/docs/pages/api/index.rst @@ -0,0 +1,13 @@ +API +--- + +These pages describe the different APIs provided by GoToSocial, both for front-end (client) interaction, +and for federation. The intended audience for these documents is developers looking to implement a front-end +or bot for GoToSocial. + +.. toctree:: + :maxdepth: 1 + + internal + client + activitypub diff --git a/docs/pages/api/internal.rst b/docs/pages/api/internal.rst new file mode 100644 index 000000000..d2a4b201c --- /dev/null +++ b/docs/pages/api/internal.rst @@ -0,0 +1,4 @@ +Internal +-------- + +This document describes the internal APIs used by GoToSocial. |