From f7899544e10334baf94245f2567c3295d3fdb1f3 Mon Sep 17 00:00:00 2001 From: Lucy Cifferello <12953208+elvece@users.noreply.github.com> Date: Wed, 10 Feb 2021 12:16:01 -0700 Subject: [PATCH] rename docs to instructions --- source/contributing/services/instructions.rst | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 source/contributing/services/instructions.rst diff --git a/source/contributing/services/instructions.rst b/source/contributing/services/instructions.rst new file mode 100644 index 0000000..6f8e7de --- /dev/null +++ b/source/contributing/services/instructions.rst @@ -0,0 +1,23 @@ +.. _service_docs: + +********************* +Service Documentation +********************* + +Within each wrapper repository should exist a ``docs`` directory. This folder should include any pertinent documentation, instructions, external integrations, or other details about the service that users or developers might find relevant. + +If an ``instructions.md`` file is included, this markdown formatted file will be rendered in the "Instructions" tab within the service detail menu on EmbassyOS: + +.. figure:: /_static/images/service/bitcoin_instructions.png + :width: 80% + :alt: Bitcoin Instructions + +Example +======= + +The `bitcoind wrapper `_ demonstrates a good use of instructions and external integrations. + +.. role:: raw-html(raw) + :format: html + +:raw-html:`
` \ No newline at end of file