From 0e0eb567fa198d249d40780ab0285aed2e9bf13e Mon Sep 17 00:00:00 2001 From: Daniel Rudolf Date: Mon, 2 Nov 2015 23:43:40 +0100 Subject: [PATCH] Update CONTRIBUTING.md Add "Keep documentation in sync" section --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b136f0..ef734dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,6 +43,12 @@ It is recommended to check your code using [PHP_CodeSniffer](https://github.com/ With this command you can specify a file or folder to limit which files it will check or omit that argument altogether, in which case the current directory is checked. +### Keep documentation in sync + +Pico accepts the problems of having redundant documentation on different places (concretely Picos inline user docs, the `README.md` and the website) for the sake of a better user experience. When updating the docs, please make sure the keep them in sync. + +If you update the [`README.md`](https://github.com/picocms/Pico/blob/master/README.md) or [`content-sample/index.md`](https://github.com/picocms/Pico/blob/master/content-sample/index.md), please make sure to update the corresponding files in the [`_docs`](https://github.com/picocms/Pico/tree/gh-pages/_docs/) folder of the `gh-pages` branch (i.e. [Picos website](http://picocms.org/docs.html)) and vice verca. Unfortunately this involves three (!) different markdown parsers. If you're experiencing problems, use Picos [`erusev/parsedown-extra`](https://github.com/erusev/parsedown-extra) as a reference. You can try to make the contents compatible to [Redcarpet](https://github.com/vmg/redcarpet) by yourself, otherwise please address the issues in your pull request message and we'll take care of it. + Versioning ----------