Contributing to the Documentation

We welcome contributions to our documentation! This guide outlines the process for contributing and provides some helpful tips.

How to Contribute

1. Fork the repository: Start by forking the repository to your own GitHub account.
2. Create a branch: Create a new branch for your changes. Use a descriptive name, such as fix-typo or add-new-section.
3. Make your changes: Edit the documentation files in your branch. The documentation is written in MDX (Markdown with JSX).
4. Test your changes: If applicable, run the documentation locally to ensure your changes look correct.
5. Commit your changes: Commit your changes with a clear and concise message.
6. Push your changes: Push your branch to your forked repository.
7. Create a pull request: Create a pull request from your branch to the main repository.

Style Guide

• Use clear and concise language.
• Write in the active voice.
• Use proper grammar and spelling.
• Follow the existing style of the documentation.
• Use code examples where appropriate.
• Keep sentences and paragraphs short and easy to read.

Adding New Components

If you're adding documentation for a new component, please follow these steps:

1. Create a new MDX file: Create a new MDX file in the appropriate directory.
2. Add a title: Add a title to the file using the following format:
3. Add content: Add the documentation for your component.
4. Add to the sidebar: Update the sidebars.js file to include your new component in the sidebar.

Using vmkit

The vmkit CLI tool can help with common tasks, such as adding new components.

This command will create a new MDX file for your component and add it to the sidebar.

Getting Help

If you have any questions, please feel free to ask in the project's discussion forum or open an issue.