diff --git a/docs/content/contribute/index.md b/docs/content/contribute/index.md index 4cce72aacfb0..5b1d60882b8b 100644 --- a/docs/content/contribute/index.md +++ b/docs/content/contribute/index.md @@ -1,48 +1,103 @@ -# Contributing to the Docs +# πŸš€ Contributing to the Docs -We welcome contributions to our documentation! If you would like to contribute, please follow the steps below. +Welcome to our documentation contribution guide! We're excited to have you here. +This guide will help you get started with contributing to our documentation. +**Let's make our docs better together! πŸ’ͺ** -## Setting up the Docs +--- -1. Clone the repository: +## πŸ› οΈ Setting up the Docs - ```shell - git clone github.com/Significant-Gravitas/AutoGPT.git - ``` +### Prerequisites -1. Install the dependencies: +- Git installed on your machine +- Python 3.8 or higher +- A text editor of your choice - ```shell - python -m pip install -r docs/requirements.txt - ``` +--- - or +### Step-by-Step Setup Guide - ```shell - python3 -m pip install -r docs/requirements.txt - ``` +1. **Clone the Repository** πŸ“₯ + ```shell + git clone https://github.com/Significant-Gravitas/AutoGPT.git + ``` -1. Start iterating using mkdocs' live server: +2. **Install Dependencies** πŸ“š + ```shell + python -m pip install -r docs/requirements.txt + ``` + **or** + ```shell + python3 -m pip install -r docs/requirements.txt + ``` - ```shell - mkdocs serve - ``` +3. **Start the Development Server** πŸ”₯ + ```shell + mkdocs serve + ``` + - Open your browser and navigate to: + `http://127.0.0.1:8000` + - Use `-a localhost:8392` to run on a different port. -1. Open your browser and navigate to `http://127.0.0.1:8000`. +4. **View the Docs** 🌐 + - Changes will auto-reload in your browser. -1. The server will automatically reload the docs when you save your changes. +--- -## Adding a new page +## πŸ“ Adding New Content -1. Create a new markdown file in the `docs/content` directory. -1. Add the new page to the `nav` section in the `mkdocs.yml` file. -1. Add the content to the new markdown file. -1. Run `mkdocs serve` to see your changes. +### Creating a New Page -## Checking links +1. **Create the File** πŸ“„ + - Navigate to `docs/content/` + - Create a new markdown file. -To check for broken links in the documentation, run `mkdocs build` and look for warnings in the console output. +2. **Update Navigation** πŸ—ΊοΈ + - Open `mkdocs.yml` + - Add the new file to the `nav` section. -## Submitting a Pull Request +3. **Verify the Page** βœ… + - Run the development server to check changes. -When you're ready to submit your changes, please create a pull request. We will review your changes and merge them if they are appropriate. +--- + +## πŸ” Quality Checks + +1. Test all links before submitting. +2. Follow existing documentation style. +3. Use proper Markdown formatting. +4. Include code examples where helpful. + +--- + +## 🎯 Submitting Your Contribution + +### Pull Request Process + +1. **Create a Branch** 🌿 + - Use a descriptive name for your branch. + - Keep changes focused and atomic. + +2. **Submit PR** πŸ“‹ + - Fill out the PR template. + - Add screenshots if applicable. + - Link related issues. + +3. **Review Process** 🧡 + - Address reviewer feedback. + - Make requested changes. + - Maintain active communication. + +--- + +## 🌟 Best Practices + +- Keep documentation clear and concise. +- Test all links before submitting. +- Follow existing documentation style. +- Include helpful code examples. + +--- + +**Thank you for contributing to our documentation! ❀️ Together, we make documentation better for everyone.**