EverestLinux/everest-web
3
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

hi

Browse Source
This commit is contained in:
Liam Waldron
2024-02-01 08:48:40 -05:00
parent 4705d60122
commit aa61054d1d
12 changed files with 103 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/meta-reading.html
View File

@@ -29,7 +29,7 @@
<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>Most Everest documentation pages will contain some type of a "card". Put simply, these are small containers 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>
@@ -72,9 +72,26 @@
<div class="news">
<p>This is an example of a news card.</p>
</div>
<h2>3 - Page Structure</h2>
<p>Everest documentation pages are organized into:</p>
<ul>
<li><a>Chapters</a></li>
<li><a>Sections</a></li>
<li><a>Subsections</a></li>
</ul>
<p><strong>3.1</strong> Chapters</p>
<p>Chapters are typically the largest sections on a given page. The topics they cover are very broad. Each chapter contains its own sections.</p>
<p>A chapter header is large, bold, has a colored sidebar, and is denoted by its number.</p>
<p><strong>3.2</strong> Sections</p>
<p>Sections are nested within chapters, and typically pertain to more specific topics related to a chapter.</p>
<p>A section header is bold, and is denoted by the number of the chapter it is nested under, followed by that section's number.</p>
<p><strong>3.3</strong> Subsections</p>
<p>Subsections are nested within sections, and usually contain very specific topics pertaining to a section (and chapter at large). Sometimes, a page does not use subsections at all.</p>
<p>A subsection header is italic, and is denoted by the number of the chapter it is nested under, followed by the number of the section it is nested under, followed by that subsection's number.</p>
</div>
<footer>
<p>Page last updated 12/07/2023 @ 12:06</p>
<p>Page last updated 1/08/2024 @ 17:28</p>
<p>Page licensed under GNU Free Documentation License 1.3 or later</p>
<p>--------------------</p>
<p>Copyright (C) 2021-2023 Everest Linux</p>