Documentation_Standards

Documentation Standards

Use this structure for new wiki pages so the documentation stays consistent and easy to edit.

File Naming

• Use two leading digits to keep the wiki order stable.
• Use title case words separated by underscores.
• Do not use the Chapter_ prefix.

Example:

09_New_Module.md

Page Structure

Use one # title per page. Use ## for main sections and ### for subsections.

# 09 New Module

## Overview

Short description of what the module does and when to use it.

<div align="center">
  <img src="resources/img/module/image.png" width="550px" alt="Module image">
  <p><em>Module image</em></p>
</div>

## Key Technical Specifications

<div align="center">

| Parameter | Description | Min | Max | Unit |
|---|---|---:|---:|---|
| VCC | Operating voltage | 3.3 | 5 | V |

</div>

## Pinout

## Features

## Safety Considerations

## Use Examples

### Connections

### Example Code

Image Format

• Center images with <div align="center">.
• Use width="550px" for module diagrams and connection images.
• Use smaller widths only when the image is naturally vertical or narrow.
• Always include an alt attribute and a short caption.

Navigation

Update these files whenever a page is added, removed, or renamed:

• _Sidebar.md
• Documentation_Index.md
• Home.md, if the page should be linked from the main page.