mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-02-04 11:55:11 -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>
121 lines
3.8 KiB
Markdown
121 lines
3.8 KiB
Markdown
# Linear Issues
|
|
<!-- MANUAL: file_description -->
|
|
Blocks for creating and managing Linear issues.
|
|
<!-- END MANUAL -->
|
|
|
|
## Linear Create Issue
|
|
|
|
### What it is
|
|
Creates a new issue on Linear
|
|
|
|
### How it works
|
|
<!-- MANUAL: how_it_works -->
|
|
This block creates a new issue in Linear using the GraphQL API. Specify the team, title, description, and optionally priority and project. The issue is created immediately and assigned to the specified team's workflow.
|
|
|
|
Returns the created issue's ID and title for tracking or further operations.
|
|
<!-- END MANUAL -->
|
|
|
|
### Inputs
|
|
|
|
| Input | Description | Type | Required |
|
|
|-------|-------------|------|----------|
|
|
| title | Title of the issue | str | Yes |
|
|
| description | Description of the issue | str | Yes |
|
|
| team_name | Name of the team to create the issue on | str | Yes |
|
|
| priority | Priority of the issue | int | No |
|
|
| project_name | Name of the project to create the issue on | str | No |
|
|
|
|
### Outputs
|
|
|
|
| Output | Description | Type |
|
|
|--------|-------------|------|
|
|
| error | Error message if the operation failed | str |
|
|
| issue_id | ID of the created issue | str |
|
|
| issue_title | Title of the created issue | str |
|
|
|
|
### Possible use case
|
|
<!-- MANUAL: use_case -->
|
|
**Bug Reporting**: Automatically create issues from error monitoring or customer reports.
|
|
|
|
**Feature Requests**: Convert feature requests from forms or support tickets into Linear issues.
|
|
|
|
**Task Automation**: Create issues based on scheduled events or external triggers.
|
|
<!-- END MANUAL -->
|
|
|
|
---
|
|
|
|
## Linear Get Project Issues
|
|
|
|
### What it is
|
|
Gets issues from a Linear project filtered by status and assignee
|
|
|
|
### How it works
|
|
<!-- MANUAL: how_it_works -->
|
|
This block retrieves issues from a Linear project with optional filtering by status and assignee. It queries the Linear GraphQL API and returns matching issues with their details.
|
|
|
|
Optionally include comments in the response for comprehensive issue data.
|
|
<!-- END MANUAL -->
|
|
|
|
### Inputs
|
|
|
|
| Input | Description | Type | Required |
|
|
|-------|-------------|------|----------|
|
|
| project | Name of the project to get issues from | str | Yes |
|
|
| status | Status/state name to filter issues by (e.g., 'In Progress', 'Done') | str | Yes |
|
|
| is_assigned | Filter by assignee status - True to get assigned issues, False to get unassigned issues | bool | No |
|
|
| include_comments | Whether to include comments in the response | bool | No |
|
|
|
|
### Outputs
|
|
|
|
| Output | Description | Type |
|
|
|--------|-------------|------|
|
|
| error | Error message if the operation failed | str |
|
|
| issues | List of issues matching the criteria | List[Issue] |
|
|
|
|
### Possible use case
|
|
<!-- MANUAL: use_case -->
|
|
**Sprint Reports**: Generate reports of issues in specific states for sprint reviews.
|
|
|
|
**Workload Analysis**: Find unassigned or overdue issues across projects.
|
|
|
|
**Status Dashboards**: Build dashboards showing issue distribution by status.
|
|
<!-- END MANUAL -->
|
|
|
|
---
|
|
|
|
## Linear Search Issues
|
|
|
|
### What it is
|
|
Searches for issues on Linear
|
|
|
|
### How it works
|
|
<!-- MANUAL: how_it_works -->
|
|
This block searches for issues in Linear using a text query. It searches across issue titles, descriptions, and other fields to find matching issues.
|
|
|
|
Returns a list of issues matching the search term.
|
|
<!-- END MANUAL -->
|
|
|
|
### Inputs
|
|
|
|
| Input | Description | Type | Required |
|
|
|-------|-------------|------|----------|
|
|
| term | Term to search for issues | str | Yes |
|
|
|
|
### Outputs
|
|
|
|
| Output | Description | Type |
|
|
|--------|-------------|------|
|
|
| error | Error message if the operation failed | str |
|
|
| issues | List of issues | List[Issue] |
|
|
|
|
### Possible use case
|
|
<!-- MANUAL: use_case -->
|
|
**Duplicate Detection**: Search for existing issues before creating new ones.
|
|
|
|
**Related Issues**: Find issues related to a specific topic or feature.
|
|
|
|
**Quick Lookup**: Search for issues by keyword for customer support or research.
|
|
<!-- END MANUAL -->
|
|
|
|
---
|