Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 04:01:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

New layout init

Browse Source
This commit is contained in:
kn0wmad
2021-12-20 14:50:47 -07:00
committed by Lucy Cifferello
parent 7f4957aaa4
commit 296362cd12
107 changed files with 70 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
site/source/support/dev-docs/service-packaging/instructions.rst Normal file
View File

@@ -0,0 +1,23 @@
.. _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 />`