mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
23 lines
883 B
ReStructuredText
23 lines
883 B
ReStructuredText
.. _service_instructions:
|
|
|
|
************************************
|
|
Service Instructions & 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 <https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs>`_ demonstrates a good use of instructions and external integrations.
|
|
|
|
.. role:: raw-html(raw)
|
|
:format: html
|
|
|
|
:raw-html:`<br />` |