Contributing to Documentation

This guide explains how to add and maintain documentation in this repository.

Prerequisites

• Basic understanding of Markdown syntax
• Access to the repository
• Familiarity with Git and version control

Adding New Documentation

Step 1: Determine Document Type

Decide which category your documentation belongs to:

• Template - Reusable document formats → docs/templates/
• Guide - Step-by-step instructions → docs/guides/
• Reference - Quick lookups and glossaries → docs/references/

Step 2: Create the Document

1. Navigate to the appropriate subdirectory
2. Create a new Markdown file with a descriptive name
3. Use lowercase and hyphens (e.g., my-guide.md)

Step 3: Write the Content

1. Start with a clear title using # Title
2. Add a brief overview at the top
3. Use appropriate heading levels (##, ###)
4. Include examples where helpful
5. Add links to related documentation

Step 4: Review and Submit

1. Proofread your documentation
2. Check all links work correctly
3. Ensure formatting displays properly
4. Submit via pull request

Best Practices

• Keep documents focused on a single topic
• Use clear, concise language
• Include practical examples
• Update the relevant ReadMe if needed
• Link to related documentation

Need Help?

If you're unsure about where to place documentation, consult the main docs/ReadMe.md or ask the team.