Rules and Conventions

This section centralizes the documentation rules used across ReaxKit.

Human-Facing Guidelines

• Docstring Content and Inclusion Guidelines

Rule References

• Docstring Update Rules
• Workflow CLI Documentation Rules
• Workflow Module Structure and Design Rules

How To Use

• Read the Markdown guideline first for human-oriented style and structure.
• Use the YAML rule files (linked inside each rule-reference page) for automated tooling and AI-agent workflows.