How to Contribute

Here's a quick overview on how to contribute to the documentation. We appreciate your help in making our documentation clear, accurate, and comprehensive!

Requirements

• GitHub Account: You'll need a GitHub account.
  • New to GitHub? Check out the official GitHub documentation for tutorials and guidance.
• Markdown Basics: A basic understanding of Markdown is required for formatting.

Guidelines

• Use the Template: A template ensures consistency across all function pages. You can find the template here.
• English: Please use proper English grammar and spelling. Avoid slang and profanity.
• Pull Requests: When submitting a pull request on GitHub, clearly explain the changes you've made in the title and description. Be specific about what you've added, modified, or removed.
• Knowledge: Only document functions you are familiar with. Double-check your work to avoid introducing errors.

Editing Documentation

1. Fork the Repository: Create your own copy of the repository by forking it.

2. Edit a File: In your forked repository, navigate to the appropriate folder (usually content/docs) and edit a file named after the function, using the .mdx extension.

3. Use the Template: Use the template as a starting point. Fill in the template with accurate and detailed information about the function.

4. Save and Commit: Save your changes and commit them to your forked repository with a descriptive commit message.

5. Create a Pull Request: Once you've completed all your changes (adding/changing documentation for one or more functions), create a pull request from your forked repository to the main repository. We will review your pull request.

Need Help?

For any additional information or assistance, please ask in our Discord support server.