-
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
Open
UDDITwork
wants to merge
4
commits into
Significant-Gravitas:dev
Choose a base branch
from
UDDITwork:patch-1
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+85
β30
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: | ||
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 |
||
`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.** |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
we should probably require a more modern version of python based on what the platform needs but that's a later problem I think