This repo is the source behind https://docs.syncthing.net/.
To edit the documentation you need a GitHub account. Once you have created one and logged in, you can edit any page by navigating to the corresponding file and clicking the edit (pen) icon. This will create a so called "fork" and a "pull request", which will be approved by one of the existing documentation team members. Once you have made a contribution or two, you can be added to the documentation team and perform edits without requiring approval.
In the long run, learning to use Git_ and running Sphinx_ on your computer is beneficial.
First steps to run it locally::
git clone https://github.com/syncthing/docs.git pip install -U Sphinx cd docs make html
You can also use our Docker image to build the documentation, which is the same thing the build server does in the end:
The documentation is divided into an index page (
index.rst) and various
subsections. The sections are:
The documentation uses the
rst format. For a starting point check out the
.. _Git: https://www.git-scm.com/
.. _Sphinx: http://sphinx-doc.org/
rst format: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
reStructuredText Primer: http://sphinx-doc.org/rest.html
All documentation and protocol specifications are licensed under the
Creative Commons Attribution 4.0 International License <https://creativecommons.org/licenses/by/4.0/>__.