From bffbdeb5347d5d72ec43a46750cbe35f75699893 Mon Sep 17 00:00:00 2001 From: tsmethurst Date: Mon, 1 Mar 2021 11:52:49 +0100 Subject: try some doc changes --- docs/pages/api/activitypub.rst | 4 ++++ docs/pages/api/client.rst | 4 ++++ docs/pages/api/index.rst | 13 +++++++++++++ docs/pages/api/internal.rst | 4 ++++ 4 files changed, 25 insertions(+) create mode 100644 docs/pages/api/activitypub.rst create mode 100644 docs/pages/api/client.rst create mode 100644 docs/pages/api/index.rst create mode 100644 docs/pages/api/internal.rst (limited to 'docs/pages/api') 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. -- cgit v1.2.3