https://github.com/syncthing/docs

Documentation site
https://github.com/syncthing/docs

documentation specification sphinx syncthing

Last synced: about 1 month ago
JSON representation

Documentation site

• Host: GitHub
• URL: https://github.com/syncthing/docs
• Owner: syncthing
• Created: 2015-05-26T07:38:21.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T07:43:22.000Z (5 months ago)
• Last Synced: 2024-04-14T04:09:52.932Z (5 months ago)
• Topics: documentation, specification, sphinx, syncthing
• Language: Python
• Homepage: http://docs.syncthing.net/
• Size: 10.3 MB
• Stars: 222
• Watchers: 38
• Forks: 455
• Open Issues: 39
• Metadata Files:
  • Readme: README.rst
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
Syncthing Docs

==============

This repo is the source behind https://docs.syncthing.net/.

Editing

-------

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

  # open _build/html/index.html

You can also use our Docker image to build the documentation, which is the

same thing the build server does in the end:

  ./docker-build.sh html

Structure

---------

The documentation is divided into an index page (``index.rst``) and various

subsections. The sections are:

- Introductory information in ``intro``.

- Information for users in ``users``.

- Information for developers in ``dev``.

The documentation uses the `rst format`_. For a starting point check out the

`reStructuredText Primer`_.

.. _Git: https://www.git-scm.com/

.. _Sphinx: https://www.sphinx-doc.org/

.. _`rst format`: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html

.. _`reStructuredText Primer`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

License

=======

All documentation and protocol specifications are licensed under the `Creative

Commons Attribution 4.0 International License

`__.