Documentation Review Process

Version: 0.1.0

Quality documentation is as important as quality code.

1. Self-Review

Before submitting a PR, the author must:

• Build the book locally (mdbook serve).
• Check for broken links.
• Verify code snippets against the current codebase.
• Run cargo test --doc if applicable.

2. Peer Review

Every documentation change requires at least one review from a core maintainer.

What to Look For

• Accuracy: Is the technical information correct?
• Clarity: Is it easy to understand?
• Consistency: Does it follow the Style Guide?
• Completeness: Are there any gaps?

3. Automated Checks (CI)

Our CI pipeline runs the following checks on documentation PRs:

• markdown-link-check: Validates all internal and external links.
• markdownlint: Checks for formatting issues.
• cargo test --doc: Compiles and runs Rust code examples.

4. Merge & Deploy

Once approved and passing CI, the PR is merged. The documentation site is automatically rebuilt and deployed to reasonkit.sh via GitHub Actions.