Back to home

1 - Introduction

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.

2 - Cards

2.1 Introduction

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:

2.2 Note

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.

NOTE:

2.3 Caution

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.

CAUTION:

2.4 Warning

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.

WARNING:

2.5 File

This card contains the contents of a text file. It is usually used to show configuration files.

FILE: example.txt

2.6 Kernel

This card contains a kernel configuration as seen in make menuconfig.

KERNEL: Enable module "example

2.7 Bigcode

The code tag is typically used to denote commands the user should run. The bigcode card is meant for showing programs, usually Bash or Python scripts, or C programs.

CODE: example.c

2.8 News

This card is meant for sharing news about the distribution. It is only found on the homepage.

1/1/70 - Example

3 - Page Structure

Everest documentation pages are organized into:

• Chapters
• Sections
• Subsections

3.1 Chapters

Chapters are typically the largest sections on a given page. The topics they cover are very broad. Each chapter contains its own sections.

A chapter header is large, bold, has a colored sidebar, and is denoted by its number.

3.2 Sections

Sections are nested within chapters, and typically pertain to more specific topics related to a chapter.

A section header is bold, and is denoted by the number of the chapter it is nested under, followed by that section's number.

3.3 Subsections

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.

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.