mirror of
https://github.com/syncthing/syncthing.git
synced 2026-04-09 08:58:05 -04:00
62 lines
2.3 KiB
ReStructuredText
62 lines
2.3 KiB
ReStructuredText
.. We register the :strike: role for strikethrough text. Use it like :strike:`this is struck out`.
|
|
.. role:: strike
|
|
|
|
Welcome to Syncthing's documentation!
|
|
=====================================
|
|
|
|
As a new user, the :ref:`getting started guide <getting-started>` is a good
|
|
place to start, then perhaps moving on to :ref:`the FAQ <faq>`. If you run
|
|
into trouble getting devices to connect to each other, the page about
|
|
:ref:`firewall setup <firewall-setup>` explains the networking necessary to
|
|
get it to work.
|
|
|
|
As a developer looking to get started with a contribution, see :ref:`how to build <building>`, :ref:`how to debug <debugging>` and the `contribution guidelines <https://github.com/syncthing/syncthing/blob/master/CONTRIBUTING.md>`_. This documentation site can be `edited here <https://github.com/syncthing/docs>`_.
|
|
|
|
Contact
|
|
-------
|
|
|
|
* If you're looking for specific people to talk to, check out the :ref:`project-presentation`.
|
|
|
|
* To report bugs or request features, please use the `issue tracker
|
|
<https://github.com/syncthing/syncthing/issues>`_. Before you do so, make
|
|
sure you are running the `latest version
|
|
<https://github.com/syncthing/syncthing/releases/latest>`_, and please do a
|
|
quick search to see if the issue has already been reported.
|
|
|
|
.. figure:: issues.png
|
|
|
|
* To report security issues, please follow the instructions on the `Security page <https://syncthing.net/security.html>`_.
|
|
|
|
* To get help and support, to discuss scenarios, or just connect with other users and developers you can head over to the `friendly forum <https://forum.syncthing.net/>`_.
|
|
|
|
* For a more real time experience, there's also an IRC channel ``#syncthing`` on `Freenode <https://freenode.net/>`_.
|
|
|
|
* For other concerns you may reach out to members of the core team, currently `@calmh <https://github.com/calmh>`_, `@AudriusButkevicius <https://github.com/AudriusButkevicius>`_ and `@Zillode <https://github.com/Zillode>`_.
|
|
|
|
The main documentation for the site is organized into a couple of sections. You can use the heading in the left sidebar to navigate the site.
|
|
|
|
.. toctree::
|
|
:caption: Introduction
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
intro/getting-started
|
|
intro/gui
|
|
intro/project-presentation
|
|
|
|
.. toctree::
|
|
:caption: For Users
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
users/faq
|
|
users/firewall
|
|
users/*
|
|
|
|
.. toctree::
|
|
:caption: For Developers
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
dev/*
|