mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-01-28 08:28:00 -05:00
c1a1767034
- Add generate_block_docs.py script that introspects block code to
generate markdown
- Support manual content preservation via <!-- MANUAL: --> markers
- Add migrate_block_docs.py to preserve existing manual content from git
HEAD
- Add CI workflow (docs-block-sync.yml) to fail if docs drift from code
- Add Claude PR review workflow (docs-claude-review.yml) for doc changes
- Add manual LLM enhancement workflow (docs-enhance.yml)
- Add GitBook configuration (.gitbook.yaml, SUMMARY.md)
- Fix non-deterministic category ordering (categories is a set)
- Add comprehensive test suite (32 tests)
- Generate docs for 444 blocks with 66 preserved manual sections
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
<!-- Clearly explain the need for these changes: -->
### Changes 🏗️
<!-- Concisely describe all of the changes made in this pull request:
-->
### Checklist 📋
#### For code changes:
- [x] I have clearly listed my changes in the PR description
- [x] I have made a test plan
- [x] I have tested my changes according to the test plan:
<!-- Put your test plan here: -->
- [x] Extensively test code generation for the docs pages
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> Introduces an automated documentation pipeline for blocks and
integrates it into CI.
>
> - Adds `scripts/generate_block_docs.py` (+ tests) to introspect blocks
and generate `docs/integrations/**`, preserving `<!-- MANUAL: -->`
sections
> - New CI workflows: **docs-block-sync** (fails if docs drift),
**docs-claude-review** (AI review for block/docs PRs), and
**docs-enhance** (optional LLM improvements)
> - Updates existing Claude workflows to use `CLAUDE_CODE_OAUTH_TOKEN`
instead of `ANTHROPIC_API_KEY`
> - Improves numerous block descriptions/typos and links across backend
blocks to standardize docs output
> - Commits initial generated docs including
`docs/integrations/README.md` and many provider/category pages
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
631e53e0f6. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
79 lines
2.6 KiB
YAML
79 lines
2.6 KiB
YAML
name: Block Documentation Sync Check
|
|
|
|
on:
|
|
push:
|
|
branches: [master, dev]
|
|
paths:
|
|
- "autogpt_platform/backend/backend/blocks/**"
|
|
- "docs/integrations/**"
|
|
- "autogpt_platform/backend/scripts/generate_block_docs.py"
|
|
- ".github/workflows/docs-block-sync.yml"
|
|
pull_request:
|
|
branches: [master, dev]
|
|
paths:
|
|
- "autogpt_platform/backend/backend/blocks/**"
|
|
- "docs/integrations/**"
|
|
- "autogpt_platform/backend/scripts/generate_block_docs.py"
|
|
- ".github/workflows/docs-block-sync.yml"
|
|
|
|
jobs:
|
|
check-docs-sync:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 15
|
|
|
|
steps:
|
|
- name: Checkout code
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 1
|
|
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "3.11"
|
|
|
|
- name: Set up Python dependency cache
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: ~/.cache/pypoetry
|
|
key: poetry-${{ runner.os }}-${{ hashFiles('autogpt_platform/backend/poetry.lock') }}
|
|
restore-keys: |
|
|
poetry-${{ runner.os }}-
|
|
|
|
- name: Install Poetry
|
|
run: |
|
|
cd autogpt_platform/backend
|
|
HEAD_POETRY_VERSION=$(python3 ../../.github/workflows/scripts/get_package_version_from_lockfile.py poetry)
|
|
echo "Found Poetry version ${HEAD_POETRY_VERSION} in backend/poetry.lock"
|
|
curl -sSL https://install.python-poetry.org | POETRY_VERSION=$HEAD_POETRY_VERSION python3 -
|
|
echo "$HOME/.local/bin" >> $GITHUB_PATH
|
|
|
|
- name: Install dependencies
|
|
working-directory: autogpt_platform/backend
|
|
run: |
|
|
poetry install --only main
|
|
poetry run prisma generate
|
|
|
|
- name: Check block documentation is in sync
|
|
working-directory: autogpt_platform/backend
|
|
run: |
|
|
echo "Checking if block documentation is in sync with code..."
|
|
poetry run python scripts/generate_block_docs.py --check
|
|
|
|
- name: Show diff if out of sync
|
|
if: failure()
|
|
working-directory: autogpt_platform/backend
|
|
run: |
|
|
echo "::error::Block documentation is out of sync with code!"
|
|
echo ""
|
|
echo "To fix this, run the following command locally:"
|
|
echo " cd autogpt_platform/backend && poetry run python scripts/generate_block_docs.py"
|
|
echo ""
|
|
echo "Then commit the updated documentation files."
|
|
echo ""
|
|
echo "Regenerating docs to show diff..."
|
|
poetry run python scripts/generate_block_docs.py
|
|
echo ""
|
|
echo "Changes detected:"
|
|
git diff ../../docs/integrations/ || true
|