-
Notifications
You must be signed in to change notification settings - Fork 44.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update index.md with better documentation #9037
base: dev
Are you sure you want to change the base?
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
<div align="center"> | ||
|
||
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 | ||
``` | ||
</div> | ||
|
||
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we should probably require a more modern version of python based on what the platform needs but that's a later problem I think |
||
|
||
```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 | ||
``` | ||
|
||
Comment on lines
+36
to
+38
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can also pass |
||
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 | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
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! ๐จ | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Really good call out here!!!! dead links are bad! |
||
## ๐ฏ 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
- Keep documentation clear and concise | ||
- Use proper Markdown formatting | ||
- Include code examples where helpful | ||
- Test all links before submitting | ||
- Follow existing documentation style | ||
|
||
--- | ||
|
||
<div align="center"> | ||
|
||
**Thank you for contributing to our documentation!** โค๏ธ | ||
|
||
*Together, we make documentation better for everyone.* | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
</div> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea process behind this but lets remove them for now since they don't work in the preview build (https://deploy-preview-9037--auto-gpt-docs-dev.netlify.app/contribute/)