diff options
author | 2021-03-01 11:52:49 +0100 | |
---|---|---|
committer | 2021-03-01 11:52:49 +0100 | |
commit | bffbdeb5347d5d72ec43a46750cbe35f75699893 (patch) | |
tree | 0fb1527f967698575a9a6c96c22c0133fd44e7b7 /docs/pages | |
parent | Doc updates (diff) | |
download | gotosocial-bffbdeb5347d5d72ec43a46750cbe35f75699893.tar.xz |
try some doc changes
Diffstat (limited to 'docs/pages')
-rw-r--r-- | docs/pages/about/about.rst (renamed from docs/pages/user_facing/user_facing.rst) | 4 | ||||
-rw-r--r-- | docs/pages/about/index.rst | 9 | ||||
-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 | ||||
-rw-r--r-- | docs/pages/design/federation.rst | 2 | ||||
-rw-r--r-- | docs/pages/design/index.rst (renamed from docs/pages/design/design.rst) | 8 | ||||
-rw-r--r-- | docs/pages/design/safety_features.rst | 2 |
9 files changed, 43 insertions, 7 deletions
diff --git a/docs/pages/user_facing/user_facing.rst b/docs/pages/about/about.rst index 2add934ad..ada763d54 100644 --- a/docs/pages/user_facing/user_facing.rst +++ b/docs/pages/about/about.rst @@ -1,5 +1,5 @@ -What is GoToSocial? -=================== +Overview +-------- GoToSocial will solve your problem of where to start with documentation, by providing a basic explanation of how to do it easily. diff --git a/docs/pages/about/index.rst b/docs/pages/about/index.rst new file mode 100644 index 000000000..75852d3c3 --- /dev/null +++ b/docs/pages/about/index.rst @@ -0,0 +1,9 @@ +About GoToSocial +---------------- + +These documents give a general overview of what GoToSocial is, and what it's trying to achieve. + +.. toctree:: + :maxdepth: 1 + + about 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. diff --git a/docs/pages/design/federation.rst b/docs/pages/design/federation.rst index 90a59148f..d6f4ea88b 100644 --- a/docs/pages/design/federation.rst +++ b/docs/pages/design/federation.rst @@ -1,5 +1,5 @@ Federation -========== +---------- In the spirit of Mastodon and other `Fediverse <https://en.wikipedia.org/wiki/Fediverse>`_ ("federation universe") applications, GoToSocial uses the `ActivityPub <https://www.w3.org/TR/activitypub/>`_ protocol to communicate between its own servers and those diff --git a/docs/pages/design/design.rst b/docs/pages/design/index.rst index f30cd746b..93f1a3486 100644 --- a/docs/pages/design/design.rst +++ b/docs/pages/design/index.rst @@ -1,8 +1,10 @@ GoToSocial Design -================= +----------------- These documents describe the design of GoToSocial and provide rationale for design decisions, safety features, etc. .. toctree:: - federation.rst - safety_features.rst + :maxdepth: 1 + + federation + safety_features diff --git a/docs/pages/design/safety_features.rst b/docs/pages/design/safety_features.rst index 65c1dc92a..ddecfc9a3 100644 --- a/docs/pages/design/safety_features.rst +++ b/docs/pages/design/safety_features.rst @@ -1,4 +1,4 @@ Safety Features -=============== +--------------- Blah blah blah blah. |