try some doc changes

This commit is contained in:
tsmethurst
2021-03-01 11:52:49 +01:00
parent 294d6d174d
commit bffbdeb534
88 changed files with 60 additions and 21254 deletions

View File

@ -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.

View File

@ -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

View File

@ -0,0 +1,4 @@
ActivityPub / Federation
------------------------
This document describes the API used for federating with other ActivityPub instances.

View File

@ -0,0 +1,4 @@
Client APIs
-----------
This document describes the client APIs exposed by GoToSocial to the outside world.

13
docs/pages/api/index.rst Normal file
View File

@ -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

View File

@ -0,0 +1,4 @@
Internal
--------
This document describes the internal APIs used by GoToSocial.

View File

@ -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

View File

@ -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

View File

@ -1,4 +1,4 @@
Safety Features
===============
---------------
Blah blah blah blah.