Skip to content

Commit 1e37afa

Browse files
authored
Update developer-docs-consolidator to write to scratchpad/dev.md (#15055)
1 parent e5339f6 commit 1e37afa

File tree

1 file changed

+8
-16
lines changed

1 file changed

+8
-16
lines changed

.github/workflows/developer-docs-consolidator.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Analyze markdown files in the specs directory, standardize their tone and format
6868

6969
- **Repository**: ${{ github.repository }}
7070
- **Specs Directory**: `scratchpad/`
71-
- **Target File**: `.github/agents/developer.instructions.agent.md`
71+
- **Target File**: `scratchpad/dev.md`
7272
- **Cache Memory**: `/tmp/gh-aw/cache-memory/`
7373

7474
## Phase 0: Setup and Configuration
@@ -261,14 +261,9 @@ Place diagrams near the concepts they illustrate, with clear captions.
261261

262262
### 1. Design Consolidated Structure
263263

264-
Create a logical structure for `developer.instructions.md`:
264+
Create a logical structure for `dev.md`:
265265

266266
```markdown
267-
---
268-
description: Developer Instructions for GitHub Agentic Workflows
269-
applyTo: "**/*"
270-
---
271-
272267
# Developer Instructions
273268

274269
## Overview
@@ -302,10 +297,9 @@ For each topic:
302297

303298
### 3. Create the Consolidated File
304299

305-
**You have direct file editing capabilities** - Write the consolidated content directly to `.github/agents/developer.instructions.agent.md` using Serena's edit tools.
300+
**You have direct file editing capabilities** - Write the consolidated content directly to `scratchpad/dev.md` using Serena's edit tools.
306301

307302
The file should:
308-
- Start with frontmatter (description and applyTo)
309303
- Have a clear structure with logical sections
310304
- Use consistent technical tone throughout
311305
- Include Mermaid diagrams for complex concepts
@@ -322,7 +316,6 @@ The file should:
322316
### 1. Validate Consolidated File
323317

324318
Check the generated file:
325-
- ✅ Has proper frontmatter
326319
- ✅ Markdown is valid
327320
- ✅ Code blocks have language tags
328321
- ✅ Mermaid diagrams render correctly
@@ -368,7 +361,7 @@ Create a comprehensive report of what was done:
368361

369362
## Summary
370363

371-
Analyzed [N] markdown files in the specs directory, made [X] tone adjustments, added [Y] Mermaid diagrams, and consolidated content into `.github/agents/developer.instructions.agent.md`.
364+
Analyzed [N] markdown files in the specs directory, made [X] tone adjustments, added [Y] Mermaid diagrams, and consolidated content into `scratchpad/dev.md`.
372365

373366
<details>
374367
<summary><b>Full Consolidation Report</b></summary>
@@ -461,7 +454,7 @@ Analyzed [N] markdown files in the specs directory, made [X] tone adjustments, a
461454

462455
## Next Steps
463456

464-
- Review the consolidated file at `.github/agents/developer.instructions.agent.md`
457+
- Review the consolidated file at `scratchpad/dev.md`
465458
- Verify Mermaid diagrams render correctly
466459
- Check that all technical content is accurate
467460
- Consider additional sections if needed
@@ -485,7 +478,7 @@ The discussion should:
485478

486479
Before the PR is created, you need to make the actual file changes:
487480

488-
1. **Update `.github/agents/developer.instructions.agent.md`**:
481+
1. **Update `scratchpad/dev.md`**:
489482
- Use Serena's editing tools (`replace_symbol_body`, `insert_after_symbol`, etc.)
490483
- Or use the standard `edit` tool to modify sections
491484
- Make all consolidation changes directly to the file
@@ -511,7 +504,7 @@ After you've made file changes, a pull request will be created automatically wit
511504
```markdown
512505
## Developer Documentation Consolidation
513506

514-
This PR consolidates markdown specifications from the `scratchpad/` directory into a unified `.github/agents/developer.instructions.agent.md` file.
507+
This PR consolidates markdown specifications from the `scratchpad/` directory into a unified `scratchpad/dev.md` file.
515508

516509
### Changes Made
517510

@@ -523,15 +516,14 @@ This PR consolidates markdown specifications from the `scratchpad/` directory in
523516

524517
### Files Modified
525518

526-
- Created/Updated: `.github/agents/developer.instructions.agent.md`
519+
- Created/Updated: `scratchpad/dev.md`
527520
- [List any spec files that were modified]
528521

529522
### Validation
530523

531524
✅ All markdown validated
532525
✅ Mermaid diagrams render correctly
533526
✅ Consistent technical tone
534-
✅ Proper frontmatter
535527

536528
### Review Notes
537529

0 commit comments

Comments
 (0)