====== Reference Manual ======

===== Location =====
----
Reference manuals  should be located at **/reference/<PRODUCT FAMILY>/<PRODUCT NAME>/reference-manual**.

===== Title =====
----
The title should be a first level ( ====== ) heading of the form: **<PRODUCT NAME> Reference Manual**

Ex:
<code>
====== Basys 3 Reference Manual ======
</code>

===== First Section =====
----
The first section should contain a product overview paragraph followed by a product image gallery using the [[software:dokuwiki:image-gallery:start]].  The product overview should highlight:

  * Intended audience and applications
  * Key features (full feature list will be in next section)
  * Key benefits

**Do Not:**
  * Include any markup between the page title and the first section content.
  * Include detailed technical specs

===== Features =====
----
The features section includes a bulleted list of product features.

===== Sections =====
----
Sections should start with a first level ( ====== ) heading of the form: **<SECTION NUMBER> <SECTION NAME>**

Ex:
<code>
====== 1 Designing with Arty ======
</code>

**Do**
  * Start section numbering with 1.
  * Separate first level headings from the following content with a horizontal line

**Do Not**
  * Include a period between the section number and the section name.
  * Separate second or greater level headings from the following content with a horizontal line

===== Sub-Sections =====
----
Sections may optionally contain sub-sections. Sub sections should start with a level 3 heading ( ==== ) of the form: **<SECTION NUMBER>.<SUBSECTION NUMBER> <SUBSECTION NAME>**

Ex:
<code>
==== 1.1 External Supply Voltage Monitoring ====
</code>

**Do**
  * Start sub-section numbering with x.1 

**Do Not** 
  * Separate sub-section headings from the following content with a horizontal line