From 294d6d174d658d1f17ec910474e89b20cdea3737 Mon Sep 17 00:00:00 2001 From: tsmethurst Date: Sun, 28 Feb 2021 18:08:27 +0100 Subject: Doc updates --- docs/_build/html/_sources/index.rst.txt | 3 +- .../html/_sources/pages/design/design.rst.txt | 8 + .../html/_sources/pages/design/federation.rst.txt | 6 + .../_sources/pages/design/safety_features.rst.txt | 4 + .../_sources/pages/user_facing/user_facing.rst.txt | 42 ++++ docs/_build/html/genindex.html | 3 +- docs/_build/html/index.html | 24 +- docs/_build/html/objects.inv | Bin 294 -> 357 bytes docs/_build/html/pages/design/design.html | 221 ++++++++++++++++++ docs/_build/html/pages/design/federation.html | 219 ++++++++++++++++++ docs/_build/html/pages/design/safety_features.html | 215 +++++++++++++++++ .../_build/html/pages/user_facing/user_facing.html | 255 +++++++++++++++++++++ docs/_build/html/search.html | 3 +- docs/_build/html/searchindex.js | 2 +- 14 files changed, 992 insertions(+), 13 deletions(-) create mode 100644 docs/_build/html/_sources/pages/design/design.rst.txt create mode 100644 docs/_build/html/_sources/pages/design/federation.rst.txt create mode 100644 docs/_build/html/_sources/pages/design/safety_features.rst.txt create mode 100644 docs/_build/html/_sources/pages/user_facing/user_facing.rst.txt create mode 100644 docs/_build/html/pages/design/design.html create mode 100644 docs/_build/html/pages/design/federation.html create mode 100644 docs/_build/html/pages/design/safety_features.html create mode 100644 docs/_build/html/pages/user_facing/user_facing.html (limited to 'docs/_build/html') diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt index 63a30217c..99661a81b 100644 --- a/docs/_build/html/_sources/index.rst.txt +++ b/docs/_build/html/_sources/index.rst.txt @@ -10,4 +10,5 @@ Welcome to GoToSocial's documentation! :maxdepth: 2 :caption: Contents: - pages/what_is_gotosocial + pages/user_facing/user_facing + pages/design/design.rst diff --git a/docs/_build/html/_sources/pages/design/design.rst.txt b/docs/_build/html/_sources/pages/design/design.rst.txt new file mode 100644 index 000000000..f30cd746b --- /dev/null +++ b/docs/_build/html/_sources/pages/design/design.rst.txt @@ -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/_build/html/_sources/pages/design/federation.rst.txt b/docs/_build/html/_sources/pages/design/federation.rst.txt new file mode 100644 index 000000000..90a59148f --- /dev/null +++ b/docs/_build/html/_sources/pages/design/federation.rst.txt @@ -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/_build/html/_sources/pages/design/safety_features.rst.txt b/docs/_build/html/_sources/pages/design/safety_features.rst.txt new file mode 100644 index 000000000..65c1dc92a --- /dev/null +++ b/docs/_build/html/_sources/pages/design/safety_features.rst.txt @@ -0,0 +1,4 @@ +Safety Features +=============== + +Blah blah blah blah. diff --git a/docs/_build/html/_sources/pages/user_facing/user_facing.rst.txt b/docs/_build/html/_sources/pages/user_facing/user_facing.rst.txt new file mode 100644 index 000000000..2add934ad --- /dev/null +++ b/docs/_build/html/_sources/pages/user_facing/user_facing.rst.txt @@ -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/_build/html/genindex.html b/docs/_build/html/genindex.html index 4ab3c88dd..ac8734b16 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/html/genindex.html @@ -84,7 +84,8 @@

Contents:

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index e9d880201..130995ab8 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -38,7 +38,7 @@ - + @@ -85,7 +85,8 @@

Contents:

@@ -158,12 +159,17 @@