Files
documentation/source/contributing/services/docs.rst
2021-02-08 08:37:38 -07:00

18 lines
655 B
ReStructuredText

.. _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
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`