From 0c2d769deee293e8ce9a4de5cfb8980b1af3406a Mon Sep 17 00:00:00 2001 From: Stefan Tatschner Date: Fri, 29 May 2015 22:45:02 +0200 Subject: [PATCH] Update the README Since we are using rst now, let's convert the README to rst as well. I also removed some obsolete Jekyll instructions and replaced them with the proper Sphinx ones. --- README.md | 36 ------------------------------------ README.rst | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 36 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 1316a5e33..000000000 --- a/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# Syncthing Docs - -This repo is the source behind http://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 what is called a "fork" and -a "pull request", which will be approved by one of the existing documentation -team members. Once you've 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 -[Jekyll](http://jekyllrb.com/) on your computer is beneficial. - -# Structure - -The documentation is divided into an index page (`index.md`) and various subsections. The sections are: - - - Introductory information in `_intro`. - - Information for users in `_users`. - - Information for developers in `_dev`. - -Each page has what is called a "front matter", which looks something like: - - ``` - --- - title: Getting Started - weight: 0 - --- - ``` - - This sets, at minimum the title of the page. There are various other attributes that can be added, the most common ones being `weight` (to adjust the order of pages in the index; lower number gets sorted higher up) and `nav` (set `nav: false` to have a page not be listed in the index). - -The rest of the page is in [Markdown format](https://help.github.com/articles/github-flavored-markdown/). diff --git a/README.rst b/README.rst new file mode 100644 index 000000000..bb7ad2b2e --- /dev/null +++ b/README.rst @@ -0,0 +1,35 @@ +Syncthing Docs +============== + +This repo is the source behind http://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 haveve 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. + +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: http://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