mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-12-18 15:33:01 -06:00
Doc updates
This commit is contained in:
parent
7867fdebd2
commit
294d6d174d
26 changed files with 1020 additions and 21 deletions
3
docs/_build/html/_sources/index.rst.txt
vendored
3
docs/_build/html/_sources/index.rst.txt
vendored
|
|
@ -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
|
||||
|
|
|
|||
8
docs/_build/html/_sources/pages/design/design.rst.txt
vendored
Normal file
8
docs/_build/html/_sources/pages/design/design.rst.txt
vendored
Normal file
|
|
@ -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
|
||||
6
docs/_build/html/_sources/pages/design/federation.rst.txt
vendored
Normal file
6
docs/_build/html/_sources/pages/design/federation.rst.txt
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
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
|
||||
of compliant software.
|
||||
4
docs/_build/html/_sources/pages/design/safety_features.rst.txt
vendored
Normal file
4
docs/_build/html/_sources/pages/design/safety_features.rst.txt
vendored
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
Safety Features
|
||||
===============
|
||||
|
||||
Blah blah blah blah.
|
||||
42
docs/_build/html/_sources/pages/user_facing/user_facing.rst.txt
vendored
Normal file
42
docs/_build/html/_sources/pages/user_facing/user_facing.rst.txt
vendored
Normal file
|
|
@ -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 <https://github.com/gotosocial/gotosocial/blob/main/LICENSE>`_ (AGPLv3).
|
||||
Loading…
Add table
Add a link
Reference in a new issue