mirror of https://github.com/Significant-Gravitas/AutoGPT.git synced 2026-01-29 08:58:07 -05:00

Files

Nicholas Tindle a318832414 feat(docs): update dev from gitbook changes (#11740 )

<!-- Clearly explain the need for these changes: -->
gitbook branch has changes that need synced to dev
### Changes 🏗️
Pull changes from gitbook into dev
<!-- Concisely describe all of the changes made in this pull request:
-->

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Migrates documentation to GitBook and removes the old MkDocs setup.
> 
> - Removes MkDocs configuration and infra: `docs/mkdocs.yml`,
`docs/netlify.toml`, `docs/overrides/main.html`,
`docs/requirements.txt`, and JS assets (`_javascript/mathjax.js`,
`_javascript/tablesort.js`)
> - Updates `docs/content/contribute/index.md` to describe GitBook
workflow (gitbook branch, editing, previews, and `SUMMARY.md`)
> - Adds GitBook navigation file `docs/platform/SUMMARY.md` and a new
platform overview page `docs/platform/what-is-autogpt-platform.md`
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
e7e118b5a8. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated contribution guide for new documentation platform and workflow
  * Added new platform overview and navigation documentation

* **Chores**
  * Removed MkDocs configuration and related dependencies
  * Removed deprecated JavaScript integrations and deployment overrides

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

2026-01-09 19:22:05 +00:00

1.1 KiB

Raw Blame History

Contributing to the Docs

We welcome contributions to our documentation! Our docs are hosted on GitBook and synced with GitHub.

How It Works

Documentation lives in the docs/ directory on the gitbook branch
GitBook automatically syncs changes from GitHub
You can edit docs directly on GitHub or locally

Editing Docs Locally

Clone the repository and switch to the gitbook branch:

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

Make your changes to markdown files in docs/
Preview changes:
- Push to a branch and create a PR - GitBook will generate a preview
- Or use any markdown preview tool locally

Adding a New Page

Create a new markdown file in the appropriate docs/ subdirectory
Add the new page to the relevant SUMMARY.md file to include it in the navigation
Submit a pull request to the gitbook branch

Submitting a Pull Request

When you're ready to submit your changes, create a pull request targeting the gitbook branch. We will review your changes and merge them if appropriate.

1.1 KiB Raw Blame History