Merge pull request #1495 from wallabag/v2-docs

add docs

3 files changed, 85 insertions, 0 deletions

diff --git a/docs/en/Developer/create_new_theme.rst b/docs/en/Developer/create_new_theme.rst
new file mode 100644
index 00000000..5731eb11
--- /dev/null
+++ b/docs/en/Developer/create_new_theme.rst
@@ -0,0 +1,4 @@
+Create new theme
+================
+
+TODO
diff --git a/docs/en/Developer/git_repo.rst b/docs/en/Developer/git_repo.rst
new file mode 100644
index 00000000..4fa5c608
--- /dev/null
+++ b/docs/en/Developer/git_repo.rst
@@ -0,0 +1,29 @@
+Git repository
+==============
+
+If you wish to contribute to the project by suggesting new features or
+by fixing some bugs, please follow the recommendations below regarding
+the git repository available at https://github.com/wallabag/wallabag.
+
+Current state
+-------------
+
+To manage the different versions of wallabag, we use Git.
+
+There are multiple branches for the source code of wallabag web app:
+
+-  ``master`` branch : this is the stable branch, downloaded by those
+   who wish to install wallabag for their own use.
+-  ``dev`` branch : before being added on ``master`` branch, all bug
+   fixes and new features must go on that branch. This branch is not
+   recommended for production use.
+-  ``v2`` branch : this is the branch for a revamp of wallabag.
+   A whole chapter is to be focused on it.
+
+Workflow
+--------
+
+All the rules for contributing to the git repository are in the
+`CONTRIBUTING.md file of
+wallabag <https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md>`__.
+Please read carefully this file before you make any change.
diff --git a/docs/en/Developer/write_config_files.rst b/docs/en/Developer/write_config_files.rst
new file mode 100644
index 00000000..c1ea61df
--- /dev/null
+++ b/docs/en/Developer/write_config_files.rst
@@ -0,0 +1,52 @@
+Write config files
+==================
+
+wallabag can use specific site config files to parse website articles.
+These files are stored in the
+```inc/3rdparty/site_config/standard`` <https://github.com/wallabag/wallabag/tree/master/inc/3rdparty/site_config/standard>`__
+folder.
+
+The format used for these files is
+`XPath <http://www.w3.org/TR/xpath20/>`__. Look at some examples in the
+folder.
+
+Automatic config files generation
+---------------------------------
+
+Fivefilters has created a `very useful
+tool <http://siteconfig.fivefilters.org/>`__ to create config files. You
+just type in the adress of the article to work on with, and you select
+the area containing the content you want.
+
+.. figure:: https://lut.im/RNaO7gGe/l9vRnO1b
+   :alt: siteconfig
+
+   siteconfig
+| You should confirm this area by trying with other articles.
+| When you got the right area, just click on *Download Full-Text RSS
+site config* to download your file.
+
+Manual config file generation
+-----------------------------
+
+If Fivefilters tool doesn't work correctly, take a look at the source
+(Ctrl + U on Firefox and Chromium). Search for your content and get the
+``class`` or the ``id`` attribute of the area containing what you want.
+
+Once you've got the id or class, you can write for example one or
+another of these lines:
+
+::
+
+    body: //div[@class='myclass']
+    body: //div[@id='myid']
+
+Then, test you file. If you got the right content but you want to strip
+unnecessary parts, do:
+
+::
+
+    strip: //div[@class='hidden']
+
+You can look at other options for siteconfig files
+`here <http://help.fivefilters.org/customer/portal/articles/223153-site-patterns>`__.