Structum Documentation Style Guide¶

Version: 1.0.0 Last Updated: 2026-01-14 Applies To: All documentation files.

1. Overview¶

This guide defines the standard structure and styling for Structum documentation to ensure consistency, professional presentation, and maintainability.

2. Document Structure¶

All documentation files must follow this three-part structure:

Header Section¶

For Modules/Plugins:

• Use standard Badge Row (see below).

• Use Metadata Table (Feature/Role/Status).

For Contributing/Guides:

• No badges required.

• Clear Title and Introduction.

• Numbered Index if covering multiple topics.

Body Section¶

• Numbered Headings: ## 1. Section Name preferred for Guides.

• Code Blocks: Always specify language (python, bash).

• Alerts: Use GitHub-style alerts (> [!NOTE]).

Footer Section¶

• See Also: Links to related documentation.

3. Badge Reference¶

Use badges only for Modules and Plugins. contributing guides do not need them.

4. Checklist¶

Before committing documentation:

• [ ] Badges match Alpha/Published status (if applicable)

• [ ] Badge order is consistent

• [ ] All required sections present

• [ ] Code blocks have language tags

• [ ] Internal links use relative paths ../folder/file.md