Contributing Documentation

This section defines documentation maintenance expectations.

Documentation standards

• Keep user docs task-oriented and concise.
• Keep developer docs contract-driven and implementation-aware.
• Prefer stable terminology for support primitives/types.
• Include screenshot placeholders where visuals are expected.

When to update docs

Update docs when changing:

• user-visible workflows or controls
• hotkey rules and interaction precedence
• file/storage contracts
• support placement/replacement behaviors
• export/runtime API contracts

Recommended validation

• Verify links and page paths remain valid for MkDocs nav.
• Build docs site locally before merging major documentation changes.
• Ensure new pages appear in mkdocs.yml navigation.