<p>Documentation for Everest is formatted in a specific way. This page explains how a page is formatted, and what certain things mean, in as much detail as possible.</p>
<h2>2 - Cards</h2>
<p><strong>2.1 </strong>Introduction</p>
<p>Most Everest documentation pages will contain some type of a "card". Put simply, these are small sections that contain file contents, kernel configurations, warnings, notes, etc. There are 6 types of cards:</p>
<p><strong>2.2 </strong>Note</p>
<p>This card is the most simple. It contains a note on a certain section. They are usually not required to read, but contain important information.</p>
<notehead><strong>NOTE:</strong></notehead>
<divclass="note">
<p>This is an example of a note card.</p>
</div>
<p><strong>2.3 </strong>Caution</p>
<p>This card is one step up from a note. It contains important information, and should be read. However, it usually isn't urgent, or if it is, it contains things that most would consider common knowledge.</p>
<p>This card is one of the most important. It contains extremely important information that, if not understood, could lead to system breakage, data loss, etc.</p>
<warnhead><strong>WARNING:</strong></warnhead>
<divclass="warning">
<p>This is an example of a warning card.</p>
</div>
<p><strong>2.5 </strong>File</p>
<p>This card contains the contents of a text file. It is usually used to show configuration files.</p>
<fhead><strong>FILE:</strong> example.txt</fhead>
<divclass="file">
<p>This is an example of a file card.</p>
</div>
<p><strong>2.6 </strong>Kernel</p>
<p>This card contains a kernel configuration as seen in <cil>make menuconfig</cil>.</p>
<p>The <cil>code</cil> tag is typically used to denote commands the user should run. The <cil>bigcode</cil> card is meant for showing programs, usually Bash or Python scripts, or C programs.</p>