​

Contribute to Cloudeval Documentation

​

How to Contribute

​

Quick Start

1. Fork the repository on GitHub
2. Create a branch for your changes
3. Make your edits to the documentation
4. Submit a pull request with a clear description

​

Contribution Types

• Fix typos or errors
• Clarify confusing sections
• Add missing information
• Improve examples
• Add screenshots or diagrams

• Tutorials for new use cases
• Feature documentation
• Best practices guides
• Troubleshooting tips

• Translate documentation to other languages
• Improve existing translations

​

Contribution Guidelines

​

Writing Style

• Clear and concise - Get to the point quickly
• Actionable - Provide step-by-step instructions
• Examples - Include real-world examples
• Visuals - Add screenshots or diagrams when helpful

​

Code Examples

• Use realistic examples
• Include expected output
• Explain what the code does
• Test all examples

​

Markdown Formatting

• Use proper heading hierarchy
• Include code blocks with syntax highlighting
• Add links to related pages
• Use lists for clarity

​

Getting Started

​

Setup Local Environment

1. Fork and clone the repository
2. Install dependencies:
   pip install -r requirements.txt
   
3. Serve locally:
   mkdocs serve
   
4. Make your changes
5. Test locally before submitting

​

Making Changes

1. Edit files in the docs/ directory
2. Preview changes with mkdocs serve
3. Test links and navigation
4. Check formatting and spelling

​

Pull Request Process

​

Before Submitting

• Tested changes locally
• Checked spelling and grammar
• Verified links work
• Updated navigation if needed
• Added to changelog if significant

​

PR Description

• What changed and why
• Screenshots if UI changes
• Related issues
• Testing performed

​

Review Process

1. We’ll review your PR within 48 hours
2. May request changes or clarifications
3. Once approved, we’ll merge
4. Your contribution will be live!

​

Documentation Structure

docs/
├── index.md              # Homepage
├── about.md              # Product overview
├── getting-started/      # Getting started guides
├── features/             # Feature documentation
├── tutorials/            # Tutorials and walkthroughs
├── faq.md                # Frequently asked questions
├── community.md          # Community information
└── support.md            # Support resources

​

Areas Needing Help

• Tutorials - Real-world use cases
• Screenshots - Visual guides
• Examples - Code and configuration examples
• Translations - Non-English documentation
• Accessibility - Improving for all users

​

Code of Conduct

• Be respectful and inclusive
• Provide constructive feedback
• Help others learn and grow
• Follow community guidelines

​

Getting Help

• Open an issue
• Join the community
• Email us

​

Recognition

• Documentation credits
• Release notes
• Community highlights