feat(issues): add issue documents and inline editing
Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
@@ -168,31 +168,23 @@ Submitted CTO hire request and linked it for board review.
|
||||
|
||||
## Planning (Required when planning requested)
|
||||
|
||||
If you're asked to make a plan, create that plan in your regular way (e.g. if you normally would use planning mode and then make a local file, do that first), but additionally update the Issue description to have your plan appended to the existing issue in `<plan/>` tags. You MUST keep the original Issue description exactly in tact. ONLY add/edit your plan. If you're asked for plan revisions, update your `<plan/>` with the revision. In both cases, leave a comment as your normally would and mention that you updated the plan.
|
||||
If you're asked to make a plan, create or update the issue document with key `plan`. Do not append plans into the issue description anymore. If you're asked for plan revisions, update that same `plan` document. In both cases, leave a comment as you normally would and mention that you updated the plan document.
|
||||
|
||||
If you're asked to make a plan, _do not mark the issue as done_. Re-assign the issue to whomever asked you to make the plan and leave it in progress.
|
||||
|
||||
Example:
|
||||
Recommended API flow:
|
||||
|
||||
Original Issue Description:
|
||||
|
||||
```
|
||||
pls show the costs in either token or dollars on the /issues/{id} page. Make a plan first.
|
||||
```bash
|
||||
PUT /api/issues/{issueId}/documents/plan
|
||||
{
|
||||
"title": "Plan",
|
||||
"format": "markdown",
|
||||
"body": "# Plan\n\n[your plan here]",
|
||||
"baseRevisionId": null
|
||||
}
|
||||
```
|
||||
|
||||
After:
|
||||
|
||||
```
|
||||
pls show the costs in either token or dollars on the /issues/{id} page. Make a plan first.
|
||||
|
||||
<plan>
|
||||
|
||||
[your plan here]
|
||||
|
||||
</plan>
|
||||
```
|
||||
|
||||
\*make sure to have a newline after/before your <plan/> tags
|
||||
If `plan` already exists, fetch the current document first and send its latest `baseRevisionId` when you update it.
|
||||
|
||||
## Setting Agent Instructions Path
|
||||
|
||||
@@ -229,6 +221,10 @@ PATCH /api/agents/{agentId}/instructions-path
|
||||
| My assignments | `GET /api/companies/:companyId/issues?assigneeAgentId=:id&status=todo,in_progress,blocked` |
|
||||
| Checkout task | `POST /api/issues/:issueId/checkout` |
|
||||
| Get task + ancestors | `GET /api/issues/:issueId` |
|
||||
| List issue documents | `GET /api/issues/:issueId/documents` |
|
||||
| Get issue document | `GET /api/issues/:issueId/documents/:key` |
|
||||
| Create/update issue document | `PUT /api/issues/:issueId/documents/:key` |
|
||||
| Get issue document revisions | `GET /api/issues/:issueId/documents/:key/revisions` |
|
||||
| Get comments | `GET /api/issues/:issueId/comments` |
|
||||
| Get specific comment | `GET /api/issues/:issueId/comments/:commentId` |
|
||||
| Update task | `PATCH /api/issues/:issueId` (optional `comment` field) |
|
||||
|
||||
Reference in New Issue
Block a user