Contribution Workflow

All documentation changes follow a Git-based workflow through GitLab. Before contributing, review the Writing Style & Standards and Writing Guide.

Branch and Merge Request Process

1. Create a branch from main using a descriptive name:

   docs/add-rbac-concept
   docs/fix-glossary-links
   docs/update-writing-guide

2. Make your changes following the writing style rules and templates.
3. Open a Merge Request (MR) against main. Fill in the MR description with a summary of what changed and why.
4. Request a review from a documentation maintainer.
5. Address review feedback, then the reviewer merges the MR.

Who Reviews and Approves

Role	Responsibility
Author	Writes content, ensures it follows the writing guide and templates, verifies links and build locally
Documentation Maintainer	Reviews for style, accuracy, structure, and completeness; approves and merges MRs
Subject Matter Expert (SME)	Reviews technical accuracy when the content covers features they own

At least one documentation maintainer must approve before merging. For technical content, an additional SME approval is recommended.

Pre-Merge Checklist

Before requesting review, verify:

• pnpm build passes locally with no broken link warnings
• New pages use the correct template
• Frontmatter includes title, description, sidebar_position, keywords, and tags
• Slug matches the file name (no silent URL changes)
• Code samples compile/run against the stated Keymate version
• Images follow Image Standards (naming, alt text, resolution)
• No real user data in examples (see Examples and Dummy Data)
• New terms are added to the Glossary if introduced

Proposing Changes to Standards

To propose changes to writing standards, templates, or glossary conventions:

1. Open an issue in the keymate-product-docs project describing the change and rationale.
2. If approved, submit an MR updating the relevant standard (writing style, writing guide, or glossary).
3. A documentation maintainer must approve changes to standards.