.. Byteflies reST document template
.. Author: First Last, First Last

.. STATUS: draft

:orphan:

.. role:: red

.. note:: This is a DRAFT

.. _optional-main-doc-anchor:

###########################
Document Template (Level 1)
###########################

One paragraph description of the purpose of the document.

For assistance with syntax, refer to the :ref:`reStructuredText tutorial <reST_tutorial>`.

.. rubric:: Quick Navigation
.. contents::
   :local:
   :depth: 2

----

.. _example-anchor-to-level-2:

***************
Level 2 Heading
***************

There is no one-size-fits-all template. To maintain consistency, fork an existing document with a similar structure or grab the source code from an existing document (``view page source`` in top-right corner of the HTML page). Eventually we will generate team-specific templates.

**A couple of pointers:**

* Make sure the purpose and context of the document is clear before getting into the details
* If the document describes a technical procedure, explain it in sufficient detail so a non-specialist can follow along, or add references to appropriate internal or external sources
* When you make a :ref:`pull request <pullreq>`, add appropriate tags to guide documentation managers
* Use *inline* **markup** (especially :red:`colors`) appropriately
* Include in-document and external (URL) references where needed\ [1]_
* If possible, use the JPG, PNG, or SVG file format for images
* Use appropriate ``syntax highlighting`` when including code examples
    - A 2\ :sup:`nd` level bullet point looks like this

.. [1] The document manager will assist with setting up references to existing parts of the documentation.

Level 3 heading
===============

Level 4 heading
---------------

Level 5 heading
~~~~~~~~~~~~~~~

.. hint:: This is an hint text block.
