From d3e5245441d1a5892734e7889c220147afad8b88 Mon Sep 17 00:00:00 2001 From: maraflush <39636038+maraflush@users.noreply.github.com> Date: Wed, 22 Jul 2020 10:05:21 +0200 Subject: [PATCH] Document the location of the documentation (#2306) * add notes to explain the documentation is split in two on cutter.re repository and the Cutter repository --- docs/source/contributing/docs/getting-started.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/contributing/docs/getting-started.rst b/docs/source/contributing/docs/getting-started.rst index f2c3f20a..b900a15a 100644 --- a/docs/source/contributing/docs/getting-started.rst +++ b/docs/source/contributing/docs/getting-started.rst @@ -16,6 +16,8 @@ How can you help? The following sections suggest ways you can contribute to Cutter's documentation. The list isn't complete as the possibilities are limitless. +The source for this documentation is available in the `docs directory `_ on Cutter's repository. When the docs are updated, they are generated and pushed directly to the website at . The source for the website and blog are available on the `cutter.re's repository `_ and are served from the ``gh-pages`` branch. + .. tip:: Document what you wished to see. If you are a user of Cutter, try to think what things you would want to see documented when you started using the project. Sometimes, the best contributions are coming from your own needs.