Skip to content
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

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 91 additions & 30 deletions docs/content/contribute/index.md
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)

Copy link
Member

@ntindle ntindle Dec 17, 2024

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/)
image

```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
Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also pass -a localhost:8392 to run it on a different port so it doesn't conflict with supabase when running the full stack

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need one more space here for this to render correctly
image

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! ๐Ÿšจ

Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above -- need an additonal space
image


- 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.*

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why this isn't bolded correctly
image

</div>
Loading