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 sections 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