Skip to content

Commit ffee290

Browse files
docs: reduce bloat in project-management.md (#7987)
1 parent 3f8c930 commit ffee290

File tree

1 file changed

+7
-67
lines changed

1 file changed

+7
-67
lines changed

docs/src/content/docs/guides/campaigns/project-management.md

Lines changed: 7 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,7 @@ Once these fields exist, orchestrator workflows can automatically populate them
2424

2525
### Automatic Timestamp Population
2626

27-
**NEW**: Starting in this release, `update-project` automatically populates date fields from issue and pull request timestamps:
28-
29-
- **Start Date** is automatically set from `createdAt` (when the issue/PR was created)
30-
- **End Date** is automatically set from `closedAt` (when the issue/PR was closed, if applicable)
31-
32-
This happens automatically for campaign project boards and requires no additional configuration. The system will:
33-
34-
1. Query the issue or PR to fetch `createdAt` and `closedAt` timestamps
35-
2. Convert timestamps to ISO date format (YYYY-MM-DD)
36-
3. Populate `Start Date` and `End Date` fields if they exist in the project and aren't already set
37-
4. Respect any manually provided date values in the `fields` parameter
27+
`update-project` automatically populates date fields from issue and pull request timestamps. If your project has `Start Date` and `End Date` fields, the system queries `createdAt` and `closedAt` timestamps, converts them to ISO format (YYYY-MM-DD), and populates the fields unless you provide explicit values.
3828

3929
**Example:** When adding issue #123 (created on 2025-12-15, closed on 2025-12-18) to a project board with "Start Date" and "End Date" fields:
4030

@@ -64,20 +54,7 @@ update-project:
6454
6555
### Orchestrator Configuration for Date Fields
6656
67-
To have orchestrators set date fields automatically, modify the orchestrator's instructions or use the `fields` parameter in `update-project` outputs.
68-
69-
**Example workflow instruction:**
70-
71-
```markdown
72-
When adding issues to the project board, set these custom fields:
73-
- `Start Date`: Set to the issue's creation date
74-
- `End Date`: Set to estimated completion date based on issue size and priority
75-
- Small issues: 3 days from start
76-
- Medium issues: 1 week from start
77-
- Large issues: 2 weeks from start
78-
```
79-
80-
**Example agent output for update-project:**
57+
Configure orchestrators to set date fields by modifying instructions or using the `fields` parameter in `update-project` outputs. Calculate end dates based on issue size and priority (e.g., small: 3 days, medium: 1 week, large: 2 weeks).
8158

8259
```yaml
8360
update-project:
@@ -92,23 +69,9 @@ update-project:
9269

9370
### Best Practices for Campaign Date Fields
9471

95-
**Recommended field names:**
96-
- `Start Date` or `start_date` - When work begins
97-
- `End Date` or `end_date` - Expected or actual completion date
98-
- `Target Date` - Optional milestone or deadline
99-
100-
**Date assignment strategies:**
72+
Use field names like `Start Date`, `End Date`, or `Target Date`. For new issues, set start date to creation date and calculate end date from estimated effort. Keep original start dates for in-progress work, updating only end dates as needed. For completed work, update end dates to actual completion.
10173

102-
- **For new issues**: Set `start_date` to current date, calculate `end_date` based on estimated effort
103-
- **For in-progress work**: Keep original `start_date`, adjust `end_date` if needed
104-
- **For completed work**: Update `end_date` to actual completion date
105-
106-
**Roadmap view benefits:**
107-
108-
- **Visual timeline**: See all campaign work laid out chronologically
109-
- **Dependency identification**: Spot overlapping or sequential work items
110-
- **Capacity planning**: Identify periods with too much concurrent work
111-
- **Progress tracking**: Compare planned vs actual completion dates
74+
Roadmap views help visualize timelines chronologically, identify overlapping work, plan capacity, and track progress against planned dates.
11275

11376
### Example: Campaign with Roadmap Tracking
11477

@@ -122,31 +85,8 @@ workflows:
12285
tracker-label: "campaign:migration-q1"
12386
```
12487

125-
The orchestrator can set date fields when adding issues:
126-
127-
```markdown
128-
## Campaign Orchestrator
129-
130-
When adding discovered issues to the project board:
131-
132-
1. Query issues with tracker-id: "migration-worker"
133-
2. For each issue:
134-
- Add to project board
135-
- Set `status` to "Todo" (or "Done" if closed)
136-
- Set `start_date` to the issue creation date
137-
- Set `end_date` based on labels:
138-
- `size:small` → 3 days from start
139-
- `size:medium` → 1 week from start
140-
- `size:large` → 2 weeks from start
141-
- Set `priority` based on issue labels
142-
143-
Generate a report showing timeline distribution of all work items.
144-
```
88+
The orchestrator queries issues with the tracker ID, adds them to the project board, sets status based on state, populates start/end dates from creation timestamps and size labels, and generates timeline reports.
14589

146-
### Limitations and Considerations
90+
### Limitations
14791

148-
- **Manual field creation**: Workflows cannot create custom fields; they must exist before workflows can update them
149-
- **Field name matching**: Custom field names are case-sensitive; use exact names as defined in the project
150-
- **Date format**: Use ISO 8601 format (YYYY-MM-DD) for date values
151-
- **No automatic recalculation**: Date fields don't auto-update; orchestrators must explicitly update them
152-
- **View configuration**: Roadmap views must be configured manually in the GitHub UI
92+
Custom fields must be created manually in the GitHub UI before workflows can update them. Field names are case-sensitive and dates must use ISO 8601 format (YYYY-MM-DD). Date fields don't auto-update; orchestrators must explicitly update them. Roadmap views require manual configuration.

0 commit comments

Comments
 (0)