From 5418558fbb1e3ea6b06faa699ed5ecaf51e665d4 Mon Sep 17 00:00:00 2001 From: UDDiT <168342115+UDDITwork@users.noreply.github.com> Date: Tue, 17 Dec 2024 19:21:07 +0530 Subject: [PATCH 1/3] Update index.md --- docs/content/contribute/index.md | 121 +++++++++++++++++++++++-------- 1 file changed, 91 insertions(+), 30 deletions(-) diff --git a/docs/content/contribute/index.md b/docs/content/contribute/index.md index 4cce72aacfb0..8f99ed577305 100644 --- a/docs/content/contribute/index.md +++ b/docs/content/contribute/index.md @@ -1,48 +1,109 @@ -# 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: +![Documentation Contributors](https://img.shields.io/github/contributors/Significant-Gravitas/AutoGPT?style=for-the-badge) +![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge) +![Documentation Build Status](https://img.shields.io/badge/docs-passing-success?style=for-the-badge) - ```shell - git clone github.com/Significant-Gravitas/AutoGPT.git - ``` +
-1. Install the dependencies: +## ๐Ÿ› ๏ธ Setting up the Docs - ```shell - python -m pip install -r docs/requirements.txt - ``` +### Prerequisites - or +- Git installed on your machine +- Python 3.8 or higher +- A text editor of your choice - ```shell - python3 -m pip install -r docs/requirements.txt - ``` +### Step-by-Step Setup Guide -1. Start iterating using mkdocs' live server: +1. **Clone the Repository** ๐Ÿ“ฅ + ```shell + git clone github.com/Significant-Gravitas/AutoGPT.git + ``` - ```shell - mkdocs serve - ``` +2. **Install Dependencies** ๐Ÿ“š + ```shell + python -m pip install -r docs/requirements.txt + ``` + or + ```shell + python3 -m pip install -r docs/requirements.txt + ``` -1. Open your browser and navigate to `http://127.0.0.1:8000`. +3. **Start the Development Server** ๐Ÿ”ฅ + ```shell + mkdocs serve + ``` -1. The server will automatically reload the docs when you save your changes. +4. **View the Docs** ๐ŸŒ + - Open your browser + - Navigate to `http://127.0.0.1:8000` + - Changes will auto-reload! ๐Ÿ”„ -## 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 your page to the `nav` section -## Submitting a Pull Request +3. **Add Content** โœ๏ธ + - Write your content using Markdown + - Add images and code examples as needed -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. +4. **Preview Changes** ๐Ÿ‘€ + - Run `mkdocs serve` + - Check your new page in the browser + +## ๐Ÿ” Quality Checks + +### Link Validation +```shell +mkdocs build +``` +Watch for any warnings about broken links in the console output! ๐Ÿšจ + +## ๐ŸŽฏ 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 +- Use proper Markdown formatting +- Include code examples where helpful +- Test all links before submitting +- Follow existing documentation style + +--- + +
+ +**Thank you for contributing to our documentation!** โค๏ธ + +*Together, we make documentation better for everyone.* + +
From 429b77c000d2f73dfe63dbf2ce8ae60b26a3cfd1 Mon Sep 17 00:00:00 2001 From: UDDiT <168342115+UDDITwork@users.noreply.github.com> Date: Wed, 18 Dec 2024 09:53:41 +0530 Subject: [PATCH 2/3] Update index.md --- docs/content/contribute/index.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/content/contribute/index.md b/docs/content/contribute/index.md index 8f99ed577305..2d5bff380436 100644 --- a/docs/content/contribute/index.md +++ b/docs/content/contribute/index.md @@ -100,10 +100,7 @@ Watch for any warnings about broken links in the console output! ๐Ÿšจ --- -
- -**Thank you for contributing to our documentation!** โค๏ธ +## Thank You for Contributing to Our Documentation! โค๏ธ -*Together, we make documentation better for everyone.* +

Together, we make documentation better for everyone.

-
From 638976ceddb3547d7dc7e211291bb4fa87da0660 Mon Sep 17 00:00:00 2001 From: UDDiT <168342115+UDDITwork@users.noreply.github.com> Date: Wed, 18 Dec 2024 10:22:10 +0530 Subject: [PATCH 3/3] Update index.md --- docs/content/contribute/index.md | 107 +++++++++++++++---------------- 1 file changed, 52 insertions(+), 55 deletions(-) diff --git a/docs/content/contribute/index.md b/docs/content/contribute/index.md index 2d5bff380436..5b1d60882b8b 100644 --- a/docs/content/contribute/index.md +++ b/docs/content/contribute/index.md @@ -1,14 +1,10 @@ # ๐Ÿš€ 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! ๐Ÿ’ช +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! ๐Ÿ’ช** -
- -![Documentation Contributors](https://img.shields.io/github/contributors/Significant-Gravitas/AutoGPT?style=for-the-badge) -![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge) -![Documentation Build Status](https://img.shields.io/badge/docs-passing-success?style=for-the-badge) - -
+--- ## ๐Ÿ› ๏ธ Setting up the Docs @@ -18,89 +14,90 @@ Welcome to our documentation contribution guide! We're excited to have you here. - Python 3.8 or higher - A text editor of your choice +--- + ### Step-by-Step Setup Guide -1. **Clone the Repository** ๐Ÿ“ฅ +1. **Clone the Repository** ๐Ÿ“ฅ ```shell - git clone github.com/Significant-Gravitas/AutoGPT.git + git clone https://github.com/Significant-Gravitas/AutoGPT.git ``` -2. **Install Dependencies** ๐Ÿ“š +2. **Install Dependencies** ๐Ÿ“š ```shell python -m pip install -r docs/requirements.txt ``` - or + **or** ```shell python3 -m pip install -r docs/requirements.txt ``` -3. **Start the Development Server** ๐Ÿ”ฅ +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. + +4. **View the Docs** ๐ŸŒ + - Changes will auto-reload in your browser. -4. **View the Docs** ๐ŸŒ - - Open your browser - - Navigate to `http://127.0.0.1:8000` - - Changes will auto-reload! ๐Ÿ”„ +--- ## ๐Ÿ“ Adding New Content ### Creating a New Page -1. **Create the File** ๐Ÿ“„ - - Navigate to `docs/content` - - Create a new markdown file +1. **Create the File** ๐Ÿ“„ + - Navigate to `docs/content/` + - Create a new markdown file. -2. **Update Navigation** ๐Ÿ—บ๏ธ - - Open `mkdocs.yml` - - Add your page to the `nav` section +2. **Update Navigation** ๐Ÿ—บ๏ธ + - Open `mkdocs.yml` + - Add the new file to the `nav` section. -3. **Add Content** โœ๏ธ - - Write your content using Markdown - - Add images and code examples as needed +3. **Verify the Page** โœ… + - Run the development server to check changes. -4. **Preview Changes** ๐Ÿ‘€ - - Run `mkdocs serve` - - Check your new page in the browser +--- ## ๐Ÿ” Quality Checks -### Link Validation -```shell -mkdocs build -``` -Watch for any warnings about broken links in the console output! ๐Ÿšจ +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 +1. **Create a Branch** ๐ŸŒฟ + - Use a descriptive name for your branch. + - Keep changes focused and atomic. -3. **Review Process** ๐Ÿ‘ฅ - - Address reviewer feedback - - Make requested changes - - Maintain active communication +2. **Submit PR** ๐Ÿ“‹ + - Fill out the PR template. + - Add screenshots if applicable. + - Link related issues. -## โญ Best Practices - -- Keep documentation clear and concise -- Use proper Markdown formatting -- Include code examples where helpful -- Test all links before submitting -- Follow existing documentation style +3. **Review Process** ๐Ÿงต + - Address reviewer feedback. + - Make requested changes. + - Maintain active communication. --- -## Thank You for Contributing to Our Documentation! โค๏ธ +## ๐ŸŒŸ Best Practices + +- Keep documentation clear and concise. +- Test all links before submitting. +- Follow existing documentation style. +- Include helpful code examples. -

Together, we make documentation better for everyone.

+--- +**Thank you for contributing to our documentation! โค๏ธ Together, we make documentation better for everyone.**