Contributor Guide

Thank you for your interest in contributing to APEX documentation! This guide will help you understand how to contribute effectively to the APEX documentation ecosystem.

Ways to Contribute

There are several ways you can help improve APEX documentation:

• Fixing Typos and Grammar: Ensure clarity and readability.
• Improving Existing Documentation: Clarify explanations, update outdated content, and enhance examples.
• Adding New Documentation: Write about features, best practices, or missing topics.
• Reviewing Contributions: Provide feedback on open documentation pull requests.

Getting Started

1. Read the Documentation

Before contributing, familiarize yourself with the APEX Writing Style Guide to maintain consistency across all contributions.

2. Follow the Style Guide

Ensure your contributions adhere to the APEX Writing Style Guide:

• Use clear and concise language.
• Follow proper grammar and punctuation.
• Use consistent formatting for headings, lists, and code blocks.
• Ensure technical accuracy.

Submitting Contributions

Reporting Issues

If you find an error or an area for improvement, please check if it has already been reported. If not, create a new issue with:

• A clear title and description.
• The affected section or page.
• Suggested improvements or corrections.

Making Documentation Changes

1. Access Decap CMS at /admin under the main documentation site to author or edit documentation.
2. Make your changes using the CMS interface.
3. Preview your changes to ensure formatting consistency.
4. Submit your edits for review and approval.

Community and Support

Code of Conduct

All contributors are expected to follow the APEX Code of Conduct to maintain a welcoming and inclusive environment.

Where to Get Help

If you need assistance, you can:

• Check the existing documentation.
• Ask in the community forums or discussion boards.

Thank You!

Your contributions help improve APEX documentation for everyone. Thank you for your support!