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/about/about.rst | 42 ++++++++++++++++++++++++++++++++++ docs/pages/about/index.rst | 9 ++++++++ docs/pages/api/activitypub.rst | 4 ++++ docs/pages/api/client.rst | 4 ++++ docs/pages/api/index.rst | 13 +++++++++++ docs/pages/api/internal.rst | 4 ++++ docs/pages/design/design.rst | 8 ------- docs/pages/design/federation.rst | 2 +- docs/pages/design/index.rst | 10 ++++++++ docs/pages/design/safety_features.rst | 2 +- docs/pages/user_facing/user_facing.rst | 42 ---------------------------------- 11 files changed, 88 insertions(+), 52 deletions(-) create mode 100644 docs/pages/about/about.rst create mode 100644 docs/pages/about/index.rst 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 delete mode 100644 docs/pages/design/design.rst create mode 100644 docs/pages/design/index.rst delete mode 100644 docs/pages/user_facing/user_facing.rst (limited to 'docs/pages') diff --git a/docs/pages/about/about.rst b/docs/pages/about/about.rst new file mode 100644 index 000000000..ada763d54 --- /dev/null +++ b/docs/pages/about/about.rst @@ -0,0 +1,42 @@ +Overview +-------- + +GoToSocial will solve your problem of where to start with documentation, +by providing a basic explanation of how to do it easily. + +Look how easy it is to use:: + + import project + # Get your stuff done + project.do_stuff() + +Features +-------- + +- Be awesome +- Make things faster + +Installation +------------ + +Install $project by running: + + install project + +Open Source +----------- + +GoToSocial is a free and open-source project. + +- Issue Tracker: https://github.com/gotosocial/gotosocial/issues +- Source Code: https://github.com/gotosocial/gotosocial + +Support +------- + +If you are having issues, please let us know. + +License +------- + +GoToSocial is licensed under the `GNU AFFERO GENERAL PUBLIC LICENSE `_ (AGPLv3). 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/design.rst b/docs/pages/design/design.rst deleted file mode 100644 index f30cd746b..000000000 --- a/docs/pages/design/design.rst +++ /dev/null @@ -1,8 +0,0 @@ -GoToSocial Design -================= - -These documents describe the design of GoToSocial and provide rationale for design decisions, safety features, etc. - -.. toctree:: - federation.rst - safety_features.rst 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 `_ ("federation universe") applications, GoToSocial uses the `ActivityPub `_ protocol to communicate between its own servers and those diff --git a/docs/pages/design/index.rst b/docs/pages/design/index.rst new file mode 100644 index 000000000..93f1a3486 --- /dev/null +++ b/docs/pages/design/index.rst @@ -0,0 +1,10 @@ +GoToSocial Design +----------------- + +These documents describe the design of GoToSocial and provide rationale for design decisions, safety features, etc. + +.. toctree:: + :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. diff --git a/docs/pages/user_facing/user_facing.rst b/docs/pages/user_facing/user_facing.rst deleted file mode 100644 index 2add934ad..000000000 --- a/docs/pages/user_facing/user_facing.rst +++ /dev/null @@ -1,42 +0,0 @@ -What is GoToSocial? -=================== - -GoToSocial will solve your problem of where to start with documentation, -by providing a basic explanation of how to do it easily. - -Look how easy it is to use:: - - import project - # Get your stuff done - project.do_stuff() - -Features --------- - -- Be awesome -- Make things faster - -Installation ------------- - -Install $project by running: - - install project - -Open Source ------------ - -GoToSocial is a free and open-source project. - -- Issue Tracker: https://github.com/gotosocial/gotosocial/issues -- Source Code: https://github.com/gotosocial/gotosocial - -Support -------- - -If you are having issues, please let us know. - -License -------- - -GoToSocial is licensed under the `GNU AFFERO GENERAL PUBLIC LICENSE `_ (AGPLv3). -- cgit v1.2.3