Skip to content

🚀 Contributing to the Docs

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

Prerequisites

  • Git installed on your machine
  • Python 3.8 or higher
  • A text editor of your choice

Step-by-Step Setup Guide

  1. Clone the Repository 📥

    git clone https://github.com/Significant-Gravitas/AutoGPT.git

  2. Install Dependencies 📚

    python -m pip install -r docs/requirements.txt
    or
    python3 -m pip install -r docs/requirements.txt

  3. Start the Development Server 🔥

    mkdocs serve

  4. Open your browser and navigate to:
    http://127.0.0.1:8000

  5. Use -a localhost:8392 to run on a different port.

  6. View the Docs 🌐

  7. Changes will auto-reload in your browser.

📝 Adding New Content

Creating a New Page

  1. Create the File 📄
  2. Navigate to docs/content/

  3. Create a new markdown file.

  4. Update Navigation 🗺️

  5. Open mkdocs.yml

  6. Add the new file to the nav section.

  7. Verify the Page ✅

  8. Run the development server to check changes.

🔍 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 🌿
  2. Use a descriptive name for your branch.

  3. Keep changes focused and atomic.

  4. Submit PR 📋

  5. Fill out the PR template.
  6. Add screenshots if applicable.

  7. Link related issues.

  8. Review Process 🧵

  9. Address reviewer feedback.
  10. Make requested changes.
  11. 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.