mirrors/gotosocial
1
0
Fork 1
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-12-25 08:30:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Doc updates

Browse source
This commit is contained in:
tsmethurst 2021-02-28 18:08:27 +01:00
parent 7867fdebd2
commit 294d6d174d
26 changed files with 1020 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/_build/doctrees/environment.pickle vendored
View file

Binary file not shown.

BIN
docs/_build/doctrees/index.doctree vendored
View file

Binary file not shown.

BIN
docs/_build/doctrees/pages/design/design.doctree vendored Normal file
View file

Binary file not shown.

BIN
docs/_build/doctrees/pages/design/federation.doctree vendored Normal file
View file

Binary file not shown.

BIN
docs/_build/doctrees/pages/design/safety_features.doctree vendored Normal file
View file

Binary file not shown.

BIN
docs/_build/doctrees/pages/user_facing/user_facing.doctree vendored Normal file
View file

Binary file not shown.

3
docs/_build/html/_sources/index.rst.txt vendored
View file

@ -10,4 +10,5 @@ Welcome to GoToSocial's documentation!
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :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
View 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
View 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
View file

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

12
docs/pages/what_is_gotosocial.rst → docs/_build/html/_sources/pages/user_facing/user_facing.rst.txt vendored
View file

@ -23,11 +23,13 @@ Install $project by running:
install project install project
Contribute Open Source
---------- -----------
- Issue Tracker: github.com/gotosocial/gotosocial/issues GoToSocial is a free and open-source project.
- Source Code: github.com/gotosocial/gotosocial
- Issue Tracker: https://github.com/gotosocial/gotosocial/issues
- Source Code: https://github.com/gotosocial/gotosocial
Support Support
------- -------
@ -37,4 +39,4 @@ If you are having issues, please let us know.
License License
------- -------
The project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE. GoToSocial is licensed under the `GNU AFFERO GENERAL PUBLIC LICENSE <https://github.com/gotosocial/gotosocial/blob/main/LICENSE>`_ (AGPLv3).

3
docs/_build/html/genindex.html vendored
View file

@ -84,7 +84,8 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="pages/what_is_gotosocial.html">What is GoToSocial?</a></li> <li class="toctree-l1"><a class="reference internal" href="pages/user_facing/user_facing.html">What is GoToSocial?</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/design/design.html">GoToSocial Design</a></li>
</ul> </ul>

24
docs/_build/html/index.html vendored
View file

@ -38,7 +38,7 @@
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="What is GoToSocial?" href="pages/what_is_gotosocial.html" /> <link rel="next" title="What is GoToSocial?" href="pages/user_facing/user_facing.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -85,7 +85,8 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="pages/what_is_gotosocial.html">What is GoToSocial?</a></li> <li class="toctree-l1"><a class="reference internal" href="pages/user_facing/user_facing.html">What is GoToSocial?</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/design/design.html">GoToSocial Design</a></li>
</ul> </ul>
@ -158,12 +159,17 @@
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="pages/what_is_gotosocial.html">What is GoToSocial?</a><ul> <li class="toctree-l1"><a class="reference internal" href="pages/user_facing/user_facing.html">What is GoToSocial?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/what_is_gotosocial.html#features">Features</a></li> <li class="toctree-l2"><a class="reference internal" href="pages/user_facing/user_facing.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/what_is_gotosocial.html#installation">Installation</a></li> <li class="toctree-l2"><a class="reference internal" href="pages/user_facing/user_facing.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/what_is_gotosocial.html#contribute">Contribute</a></li> <li class="toctree-l2"><a class="reference internal" href="pages/user_facing/user_facing.html#open-source">Open Source</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/what_is_gotosocial.html#support">Support</a></li> <li class="toctree-l2"><a class="reference internal" href="pages/user_facing/user_facing.html#support">Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/what_is_gotosocial.html#license">License</a></li> <li class="toctree-l2"><a class="reference internal" href="pages/user_facing/user_facing.html#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/design/design.html">GoToSocial Design</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/design/federation.html">Federation</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/design/safety_features.html">Safety Features</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -176,7 +182,7 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="pages/what_is_gotosocial.html" class="btn btn-neutral float-right" title="What is GoToSocial?" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="pages/user_facing/user_facing.html" class="btn btn-neutral float-right" title="What is GoToSocial?" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div> </div>
<hr/> <hr/>

BIN
docs/_build/html/objects.inv vendored
View file

Binary file not shown.

221
docs/_build/html/pages/design/design.html vendored Normal file
View file

@ -0,0 +1,221 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>GoToSocial Design &mdash; GoToSocial documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Federation" href="federation.html" />
<link rel="prev" title="What is GoToSocial?" href="../user_facing/user_facing.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> GoToSocial
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../user_facing/user_facing.html">What is GoToSocial?</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">GoToSocial Design</a><ul>
<li class="toctree-l2"><a class="reference internal" href="federation.html">Federation</a></li>
<li class="toctree-l2"><a class="reference internal" href="safety_features.html">Safety Features</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">GoToSocial</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li>GoToSocial Design</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/pages/design/design.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="gotosocial-design">
<h1>GoToSocial Design<a class="headerlink" href="#gotosocial-design" title="Permalink to this headline"></a></h1>
<p>These documents describe the design of GoToSocial and provide rationale for design decisions, safety features, etc.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="federation.html">Federation</a></li>
<li class="toctree-l1"><a class="reference internal" href="safety_features.html">Safety Features</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="federation.html" class="btn btn-neutral float-right" title="Federation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../user_facing/user_facing.html" class="btn btn-neutral float-left" title="What is GoToSocial?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, GoToSocial Authors.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

219
docs/_build/html/pages/design/federation.html vendored Normal file
View file

@ -0,0 +1,219 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Federation &mdash; GoToSocial documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Safety Features" href="safety_features.html" />
<link rel="prev" title="GoToSocial Design" href="design.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> GoToSocial
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../user_facing/user_facing.html">What is GoToSocial?</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="design.html">GoToSocial Design</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Federation</a></li>
<li class="toctree-l2"><a class="reference internal" href="safety_features.html">Safety Features</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">GoToSocial</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="design.html">GoToSocial Design</a> &raquo;</li>
<li>Federation</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/pages/design/federation.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="federation">
<h1>Federation<a class="headerlink" href="#federation" title="Permalink to this headline"></a></h1>
<p>In the spirit of Mastodon and other <a class="reference external" href="https://en.wikipedia.org/wiki/Fediverse">Fediverse</a> (“federation universe”) applications,
GoToSocial uses the <a class="reference external" href="https://www.w3.org/TR/activitypub/">ActivityPub</a> protocol to communicate between its own servers and those
of compliant software.</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="safety_features.html" class="btn btn-neutral float-right" title="Safety Features" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="design.html" class="btn btn-neutral float-left" title="GoToSocial Design" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, GoToSocial Authors.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

215
docs/_build/html/pages/design/safety_features.html vendored Normal file
View file

@ -0,0 +1,215 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Safety Features &mdash; GoToSocial documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="prev" title="Federation" href="federation.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> GoToSocial
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../user_facing/user_facing.html">What is GoToSocial?</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="design.html">GoToSocial Design</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="federation.html">Federation</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Safety Features</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">GoToSocial</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="design.html">GoToSocial Design</a> &raquo;</li>
<li>Safety Features</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/pages/design/safety_features.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="safety-features">
<h1>Safety Features<a class="headerlink" href="#safety-features" title="Permalink to this headline"></a></h1>
<p>Blah blah blah blah.</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="federation.html" class="btn btn-neutral float-left" title="Federation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, GoToSocial Authors.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

255
docs/_build/html/pages/user_facing/user_facing.html vendored Normal file
View file

@ -0,0 +1,255 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>What is GoToSocial? &mdash; GoToSocial documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="GoToSocial Design" href="../design/design.html" />
<link rel="prev" title="Welcome to GoToSocial’s documentation!" href="../../index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> GoToSocial
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">What is GoToSocial?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#open-source">Open Source</a></li>
<li class="toctree-l2"><a class="reference internal" href="#support">Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../design/design.html">GoToSocial Design</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">GoToSocial</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li>What is GoToSocial?</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/pages/user_facing/user_facing.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="what-is-gotosocial">
<h1>What is GoToSocial?<a class="headerlink" href="#what-is-gotosocial" title="Permalink to this headline"></a></h1>
<p>GoToSocial will solve your problem of where to start with documentation,
by providing a basic explanation of how to do it easily.</p>
<p>Look how easy it is to use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">project</span>
<span class="c1"># Get your stuff done</span>
<span class="n">project</span><span class="o">.</span><span class="n">do_stuff</span><span class="p">()</span>
</pre></div>
</div>
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Be awesome</p></li>
<li><p>Make things faster</p></li>
</ul>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
<p>Install $project by running:</p>
<blockquote>
<div><p>install project</p>
</div></blockquote>
</div>
<div class="section" id="open-source">
<h2>Open Source<a class="headerlink" href="#open-source" title="Permalink to this headline"></a></h2>
<p>GoToSocial is a free and open-source project.</p>
<ul class="simple">
<li><p>Issue Tracker: <a class="reference external" href="https://github.com/gotosocial/gotosocial/issues">https://github.com/gotosocial/gotosocial/issues</a></p></li>
<li><p>Source Code: <a class="reference external" href="https://github.com/gotosocial/gotosocial">https://github.com/gotosocial/gotosocial</a></p></li>
</ul>
</div>
<div class="section" id="support">
<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline"></a></h2>
<p>If you are having issues, please let us know.</p>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
<p>GoToSocial is licensed under the <a class="reference external" href="https://github.com/gotosocial/gotosocial/blob/main/LICENSE">GNU AFFERO GENERAL PUBLIC LICENSE</a> (AGPLv3).</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../design/design.html" class="btn btn-neutral float-right" title="GoToSocial Design" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../../index.html" class="btn btn-neutral float-left" title="Welcome to GoToSocial’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, GoToSocial Authors.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

3
docs/_build/html/search.html vendored
View file

@ -87,7 +87,8 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="pages/what_is_gotosocial.html">What is GoToSocial?</a></li> <li class="toctree-l1"><a class="reference internal" href="pages/user_facing/user_facing.html">What is GoToSocial?</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/design/design.html">GoToSocial Design</a></li>
</ul> </ul>

2
docs/_build/html/searchindex.js vendored
View file

@ -1 +1 @@
Search.setIndex({docnames:["index","pages/what_is_gotosocial"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["index.rst","pages/what_is_gotosocial.rst"],objects:{},objnames:{},objtypes:{},terms:{"import":1,"public":1,The:1,affero:1,awesom:1,basic:1,code:1,com:1,content:0,contribut:0,do_stuff:1,document:1,done:1,easi:1,easili:1,explan:1,faster:1,featur:0,gener:1,get:1,github:1,gnu:1,gotopub:[],have:1,how:1,index:[],instal:0,issu:1,know:1,let:1,licens:0,look:1,make:1,modul:[],page:[],pleas:1,problem:1,project:1,provid:1,run:1,search:[],solv:1,sourc:1,start:1,stuff:1,support:0,thi:[],thing:1,tracker:1,under:1,use:1,what:0,where:1,you:1,your:1},titles:["Welcome to GoToSocial\u2019s documentation!","What is GoToSocial?"],titleterms:{contribut:1,document:0,featur:1,gotosoci:[0,1],indic:[],instal:1,licens:1,project:[],support:1,tabl:[],thi:[],welcom:0,what:1}}) Search.setIndex({docnames:["index","pages/design/design","pages/design/federation","pages/design/safety_features","pages/user_facing/user_facing"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["index.rst","pages/design/design.rst","pages/design/federation.rst","pages/design/safety_features.rst","pages/user_facing/user_facing.rst"],objects:{},objnames:{},objtypes:{},terms:{"import":4,"public":4,The:[],These:1,activitypub:2,affero:4,agplv3:4,applic:2,awesom:4,basic:4,between:2,blah:3,bleep:[],bloop:[],code:4,com:4,commun:2,compliant:2,content:0,contribut:[],cool:[],decis:1,describ:1,design:0,do_stuff:4,document:[1,4],done:4,easi:4,easili:4,etc:1,explan:4,faster:4,featur:[0,1],feder:[0,1],fedivers:2,free:4,gener:4,get:4,github:4,gnu:4,gotopub:[],gotosoci:2,have:4,how:4,http:4,index:[],instal:0,issu:4,its:2,know:4,let:4,licens:0,look:4,make:4,mastodon:2,modul:[],open:0,org:[],other:2,own:2,page:[],pleas:4,problem:4,project:4,protocol:2,provid:[1,4],rational:1,run:4,safeti:[0,1],search:[],server:2,softwar:2,solv:4,sourc:0,spirit:2,start:4,stuff:4,support:0,thi:[],thing:4,those:2,tracker:4,under:4,univers:2,use:4,uses:2,what:0,where:4,wiki:[],wikipedia:[],www:[],you:4,your:4},titles:["Welcome to GoToSocial\u2019s documentation!","GoToSocial Design","Federation","Safety Features","What is GoToSocial?"],titleterms:{contribut:[],design:1,document:0,featur:[3,4],feder:2,gotosoci:[0,1,4],indic:[],instal:4,licens:4,open:4,project:[],safeti:3,sourc:4,support:4,tabl:[],thi:[],welcom:0,what:4}})

3
docs/conf.py
View file

@ -39,7 +39,6 @@ templates_path = ['_templates']
# This pattern also affects html_static_path and html_extra_path. # This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
@ -50,4 +49,4 @@ html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']

3
docs/index.rst
View file

@ -10,4 +10,5 @@ Welcome to GoToSocial's documentation!
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
pages/what_is_gotosocial pages/user_facing/user_facing
pages/design/design.rst

8
docs/pages/design/design.rst Normal file
View 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/pages/design/federation.rst Normal file
View 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/pages/design/safety_features.rst Normal file
View file

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

42
docs/pages/user_facing/user_facing.rst Normal file
View 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).