Documentation rules for GitHub Wiki

Documentation structure

1. Title and meta-info

Disallowed in titles: ?, *, <, >, :

# Page title

> [!IMPORTANT]  
> **Status**: [Supported/Deprecated/WIP]  
> **Minimal version**: [Product version]  
> **Last updated**: [YYYY-MM-DD]

2. Overview

Brief description:

## Overview

[1–3 paragraphs explaining the key concept]  
[One-sentence usage example]

3. Syntax and usage

3.1 Basic syntax

## Syntax

[Clear format description]  
[Minimal working example]

3.2 Advanced features

Add when applicable.

4. Usage examples

Examples

Scenario 1: [Title]

[example code]

→ [Result explanation]

Scenario 2: [Title]

[example code]

→ [Result explanation]

5. Recommendations and constraints

Guidelines

• ✔ Good usage:
  [Practical advice]
• ⚠ Limitations:
  [Potential issues and mitigations]
• ✖ Anti-patterns:
  [Common mistakes]

6. Related sections

See also

• Link to another Wiki page
• External doc

---

Extra formatting rules

1. Code formatting

• Use code fences with language:

• #include "file.ltx"

• Inline code: `inside text`

2. Visual callouts

• Notes:

  > [!NOTE]  
  > Explanatory text

• Warnings:

  > [!WARNING]  
  > Warning text

3. Links and cross-references

• Inside Wiki:

  [link text](Page-Name)

• External:

  [text](https://example.com)

4. Images and diagrams

![Image description](https://example.com/image.png)

Pre-publish checklist

1. Verify all code examples work
2. Ensure links point to current pages
3. Check grammar and readability