From de0674c11679138f99954ad32e8917521c433899 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Fri, 2 Aug 2019 13:17:22 +0200 Subject: [PATCH] Add a template for creating new documentation page Related to #1695 --- docs/contributing.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index d651d448..0ae2a427 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -105,11 +105,19 @@ tags for other features). e.g. list * Crosslinks to different pages should target the `top` anchor, like this `[link to contributing](contributing.md#top)`. -* If you have introduced a new document, please add a a `top` anchor at -the top, like this +* If you have introduced a new document, there is a simple template you +should use. It provides you with the top anchor mentioned above, and also +with a backlink to the top of the documentation: ```markdown -# Contributing to Catch +# Cool feature + +Text that explains how to use the cool feature. + + +--- + +[Home](Readme.md#top) ``` * For pages with more than 4 subheadings, we provide a table of contents (ToC) at the top of the page. Because GitHub markdown does not support