docs: reposition Tasks as API-first automation system #21216
Conversation
Updates Tasks documentation to emphasize its API-first design for automation workflows like GitHub Actions, CI/CD pipelines, and scheduled jobs. Adds common use case examples and clarifies that tasks can be triggered via API, CLI, or web UI. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
📚 Documentation Check✨ No Changes NeededThis PR already contains comprehensive documentation updates to
The documentation updates are well-aligned with the PR's goal of emphasizing Tasks' automation capabilities and are complete as-is. This comment was generated by an AI Agent through Coder Tasks |
📚 Documentation Check✅ Updates NeededBased on the new "API-first automation system" positioning in this PR, the following files need updates to maintain consistency:
📝 RationaleThis PR repositions Tasks from a simple "interface for running agents" to an "API-first system for automating software development workflows." The three files above still use the old positioning language, creating inconsistency in how users understand what Tasks is designed for. The updated language in tasks.md emphasizes:
These three files should reflect the same positioning for consistency across the documentation. This comment was generated by an AI Agent through Coder Tasks |
david-fraley
left a comment
There was a problem hiding this comment.
Left some thoughts. Also ran the doc-check workflow on the PR; let's address those comments as well
| # Coder Tasks | ||
|
|
||
| Coder Tasks is an interface for running & managing coding agents such as Claude Code and Aider, powered by Coder workspaces. | ||
| Coder Tasks is an API-first system for automating software development workflows with any AI coding agent, like Claude Code and Sourcegraph Amp. Tasks are designed for automation scenarios like CI/CD pipelines, GitHub Actions, scheduled jobs, and issue triaging where agents can work autonomously on well-defined tasks. |
There was a problem hiding this comment.
| Coder Tasks is an API-first system for automating software development workflows with any AI coding agent, like Claude Code and Sourcegraph Amp. Tasks are designed for automation scenarios like CI/CD pipelines, GitHub Actions, scheduled jobs, and issue triaging where agents can work autonomously on well-defined tasks. | |
| Coder Tasks is an API-first system for automating software development workflows with any AI coding agent, like Claude Code and Sourcegraph Amp. Tasks are meant for augmenting and automating repeatable parts of your SDLC with AI and coding agents. They can easily be integrated into your work management systems like GitHub or project trackers like Jira. |
There was a problem hiding this comment.
I'm unsure I like the Jira callout here, but it's kinda on the roadmap
|
|
||
| Tasks are designed for automation workflows where AI agents can work independently: | ||
|
|
||
| - **CI/CD Integration**: Trigger tasks from GitHub Actions, GitLab CI, or Jenkins to automatically address issues, update dependencies, or generate documentation when code changes |
There was a problem hiding this comment.
This item feels out of place. It's not a use case, but rather where it can be integrated. I recommend removing
|
|
||
| - **CLI Commands**: See [Tasks CLI](./cli.md) for creating, monitoring, and managing tasks from scripts or CI/CD pipelines | ||
| - **REST API**: See [Tasks API Reference](../reference/api/tasks.md) for HTTP endpoints to integrate task creation into your automation workflows | ||
| - **GitHub Actions**: Use the [create-task-action](https://github.com/coder/create-task-action) to trigger tasks from GitHub workflows |
There was a problem hiding this comment.
I would remove this as it feels like a random inclusion to the list. If we want to keep the callout, we can add a new section around "current and planned integrations"
Updates Tasks documentation to emphasize its API-first design for automation workflows like GitHub Actions, CI/CD pipelines, and scheduled jobs. Adds common use case examples and clarifies that tasks can be triggered via API, CLI, or web UI.
🤖 Generated with Claude Code