Contributing to Documentation

We welcome contributions to the Juice documentation! This guide will help you understand how to make changes to our documentation.

Editing Pages Directly on GitHub

Every page in our documentation has an "Edit this page" link at the bottom. Clicking this link will take you to GitHub where you can make changes directly in your browser.

Steps to Edit a Page

1. Click the "Edit this page" button at the bottom of any documentation page
2. You'll be taken to GitHub's editor for that file
3. Make your changes in the editor
4. Scroll down to the "Commit changes" section
5. Add a brief description of your changes
6. Select "Create a new branch for this commit and start a pull request"
7. Click "Propose changes"
8. On the next page, add any additional information about your changes
9. Click "Create pull request"

Our team will review your changes and merge them if appropriate.

Making Larger Contributions

For more substantial contributions, you may want to set up a local development environment:

1. Fork the repository on GitHub
2. Clone your fork to your local machine
3. Install dependencies with npm install
4. Start the development server with npm start
5. Make your changes
6. Commit and push your changes to your fork
7. Create a pull request from your fork to the main repository

Documentation Structure

Our documentation is organized as follows:

• docs/juice/intro.md: Main introduction page
• docs/juice/admin/: Documentation for administrators
• docs/juice/pro-users/: Documentation for professional users
• docs/juice/other-juice-docs/: Additional documentation

Writing Guidelines

When contributing to our documentation, please follow these guidelines:

• Use clear, concise language
• Include examples where appropriate
• Use headings to organize content
• Include screenshots for UI-related documentation
• Test any code examples you include

Thank you for helping improve our documentation!