Skip to content

Update developer-docs-consolidator to write to scratchpad/dev.md #15055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 2 commits into from
Feb 12, 2026
Merged

Update developer-docs-consolidator to write to scratchpad/dev.md #15055

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5c9c1e
Initial plan
Copilot Feb 12, 2026
f281271
Update developer-docs-consolidator to write to scratchpad/dev.md
Copilot Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 8 additions & 16 deletions .github/workflows/developer-docs-consolidator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Analyze markdown files in the specs directory, standardize their tone and format

- **Repository**: ${{ github.repository }}
- **Specs Directory**: `scratchpad/`
- **Target File**: `.github/agents/developer.instructions.agent.md`
- **Target File**: `scratchpad/dev.md`
Copy link

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change updates the source workflow spec, but the compiled .github/workflows/developer-docs-consolidator.lock.yml must also be regenerated and committed; otherwise the actual GitHub Actions workflow won’t reflect the new output path. Run gh aw compile developer-docs-consolidator (or gh aw compile) after updating the .md, per .github/aw/github-agentic-workflows.md.

Suggested change
- **Target File**: `scratchpad/dev.md`
- **Target File**: `scratchpad/developer.instructions.md`

Copilot uses AI. Check for mistakes.
- **Cache Memory**: `/tmp/gh-aw/cache-memory/`

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

### 1. Design Consolidated Structure

Create a logical structure for `developer.instructions.md`:
Create a logical structure for `dev.md`:

```markdown
---
description: Developer Instructions for GitHub Agentic Workflows
applyTo: "**/*"
---

# Developer Instructions

## Overview
Expand Down Expand Up @@ -302,10 +297,9 @@ For each topic:

### 3. Create the Consolidated File

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

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

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

## Summary

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`.
Analyzed [N] markdown files in the specs directory, made [X] tone adjustments, added [Y] Mermaid diagrams, and consolidated content into `scratchpad/dev.md`.
Copy link

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The report summary still says “Analyzed [N] markdown files in the specs directory…”, but this workflow’s input directory is scratchpad/. Consider changing “specs directory” to scratchpad/ here to keep terminology consistent with earlier sections and avoid confusion in generated reports.

This issue also appears in the following locations of the same file:

  • line 69
  • line 318
Suggested change
Analyzed [N] markdown files in the specs directory, made [X] tone adjustments, added [Y] Mermaid diagrams, and consolidated content into `scratchpad/dev.md`.
Analyzed [N] markdown files in the `scratchpad/` directory, made [X] tone adjustments, added [Y] Mermaid diagrams, and consolidated content into `scratchpad/dev.md`.

Copilot uses AI. Check for mistakes.

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

## Next Steps

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

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

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

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

### Changes Made

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

### Files Modified

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

### Validation

✅ All markdown validated
✅ Mermaid diagrams render correctly
✅ Consistent technical tone
✅ Proper frontmatter

### Review Notes

Expand Down