mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-04-08 03:00:28 -04: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>
54 lines
2.5 KiB
Markdown
54 lines
2.5 KiB
Markdown
## Read Discord Messages
|
|
|
|
### What it is
|
|
A block that reads messages from a Discord channel using a bot token.
|
|
|
|
### What it does
|
|
This block connects to Discord using a bot token and retrieves messages from a specified channel. It can operate continuously or retrieve a single message.
|
|
|
|
### How it works
|
|
The block uses a Discord bot to log into a server and listen for new messages. When a message is received, it extracts the content, channel name, and username of the sender. If the message contains a text file attachment, the block also retrieves and includes the file's content.
|
|
|
|
### Inputs
|
|
| Input | Description |
|
|
|-------|-------------|
|
|
| Discord Bot Token | A secret token used to authenticate the bot with Discord |
|
|
| Continuous Read | A boolean flag indicating whether to continuously read messages or stop after one message |
|
|
|
|
### Outputs
|
|
| Output | Description |
|
|
|--------|-------------|
|
|
| Message Content | The text content of the received message, including any attached file content |
|
|
| Channel Name | The name of the Discord channel where the message was received |
|
|
| Username | The name of the user who sent the message |
|
|
|
|
### Possible use case
|
|
This block could be used to monitor a Discord channel for support requests. When a user posts a message, the block captures it, allowing another part of the system to process and respond to the request.
|
|
|
|
---
|
|
|
|
## Send Discord Message
|
|
|
|
### What it is
|
|
A block that sends messages to a Discord channel using a bot token.
|
|
|
|
### What it does
|
|
This block connects to Discord using a bot token and sends a specified message to a designated channel.
|
|
|
|
### How it works
|
|
The block uses a Discord bot to log into a server, locate the specified channel, and send the provided message. If the message is longer than Discord's character limit, it automatically splits the message into smaller chunks and sends them sequentially.
|
|
|
|
### Inputs
|
|
| Input | Description |
|
|
|-------|-------------|
|
|
| Discord Bot Token | A secret token used to authenticate the bot with Discord |
|
|
| Message Content | The text content of the message to be sent |
|
|
| Channel Name | Channel ID or channel name to send the message to |
|
|
|
|
### Outputs
|
|
| Output | Description |
|
|
|--------|-------------|
|
|
| Status | A string indicating the result of the operation (e.g., "Message sent" or "Channel not found") |
|
|
|
|
### Possible use case
|
|
This block could be used as part of an automated notification system. For example, it could send alerts to a Discord channel when certain events occur in another system, such as when a new user signs up or when a critical error is detected. |