From 4148d2b6ddec96722c0e9ec2eda0c197f2622905 Mon Sep 17 00:00:00 2001 From: Lucy Cifferello Date: Mon, 19 Oct 2020 14:50:29 -0600 Subject: [PATCH] update contributing guide --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a7d865..143a35f 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,9 @@ If you notice a mistake in the docs, or you have an idea for improving them, we ### Guide Templates -We welcome contributions to add a guide to this documentation repository. Please reference the template [here](source/contributing/template.rst) and use proper `rst` style syntax. +We welcome contributions to add a guide to this documentation repository. Please reference the template [here](source/contributing/template.rst) and use proper restructured text syntax. + +Guides should live under `./source/user-manuals/external`. If they are bitcoin related, add a section title for the next integration guide in the `bitcoin.rst` page. If the guide belongs in a new topic, create a new `.rst` file with an appropriate name following the template conventions. Don't forget to include the new page in the `index.rst` file toctree within the external folder. All images should be placed in `./source/_static/images` with descriptive labeling.