From 294d6d174d658d1f17ec910474e89b20cdea3737 Mon Sep 17 00:00:00 2001 From: tsmethurst Date: Sun, 28 Feb 2021 18:08:27 +0100 Subject: Doc updates --- docs/pages/design/design.rst | 8 +++++++ docs/pages/design/federation.rst | 6 +++++ docs/pages/design/safety_features.rst | 4 ++++ docs/pages/user_facing/user_facing.rst | 42 ++++++++++++++++++++++++++++++++++ docs/pages/what_is_gotosocial.rst | 40 -------------------------------- 5 files changed, 60 insertions(+), 40 deletions(-) create mode 100644 docs/pages/design/design.rst create mode 100644 docs/pages/design/federation.rst create mode 100644 docs/pages/design/safety_features.rst create mode 100644 docs/pages/user_facing/user_facing.rst delete mode 100644 docs/pages/what_is_gotosocial.rst (limited to 'docs/pages') diff --git a/docs/pages/design/design.rst b/docs/pages/design/design.rst new file mode 100644 index 000000000..f30cd746b --- /dev/null +++ b/docs/pages/design/design.rst @@ -0,0 +1,8 @@ +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 new file mode 100644 index 000000000..90a59148f --- /dev/null +++ b/docs/pages/design/federation.rst @@ -0,0 +1,6 @@ +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 +of compliant software. diff --git a/docs/pages/design/safety_features.rst b/docs/pages/design/safety_features.rst new file mode 100644 index 000000000..65c1dc92a --- /dev/null +++ b/docs/pages/design/safety_features.rst @@ -0,0 +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 new file mode 100644 index 000000000..2add934ad --- /dev/null +++ b/docs/pages/user_facing/user_facing.rst @@ -0,0 +1,42 @@ +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). diff --git a/docs/pages/what_is_gotosocial.rst b/docs/pages/what_is_gotosocial.rst deleted file mode 100644 index c4e2c706c..000000000 --- a/docs/pages/what_is_gotosocial.rst +++ /dev/null @@ -1,40 +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 - -Contribute ----------- - -- Issue Tracker: github.com/gotosocial/gotosocial/issues -- Source Code: github.com/gotosocial/gotosocial - -Support -------- - -If you are having issues, please let us know. - -License -------- - -The project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE. \ No newline at end of file -- cgit v1.3