Update developer-docs-consolidator to write to scratchpad/dev.md#15055
Update developer-docs-consolidator to write to scratchpad/dev.md#15055
Conversation
- Updated target file path from .github/agents/developer.instructions.agent.md to scratchpad/dev.md - Removed agent-specific frontmatter requirements (description and applyTo fields) - Simplified consolidated file structure to just markdown content - Updated all references in prompts, validation criteria, and PR template - Workflow compiles successfully with no errors or warnings Fixes #14938 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the developer-docs-consolidator agentic workflow spec so its consolidated output is written to scratchpad/dev.md (plain markdown) rather than an agent instructions file under .github/agents/.
Changes:
- Retarget consolidated output path to
scratchpad/dev.mdthroughout the workflow spec. - Remove agent-specific YAML frontmatter from the consolidated file template and validation checklist.
- Update report/PR-template text to reference the new output location.
Comments suppressed due to low confidence (2)
.github/workflows/developer-docs-consolidator.md:72
- The workflow prompt still says it produces a consolidated
developer.instructions.mdfile (see earlier in this file), but the target has been changed toscratchpad/dev.md. This inconsistency can cause the agent to write to the wrong file—update the introductory description to referencescratchpad/dev.md(ordev.md) consistently.
- **Repository**: ${{ github.repository }}
- **Specs Directory**: `scratchpad/`
- **Target File**: `scratchpad/dev.md`
- **Cache Memory**: `/tmp/gh-aw/cache-memory/`
.github/workflows/developer-docs-consolidator.md:323
- Phase 5 removed the frontmatter validation bullet, but the report template later in this workflow still includes “✅ Frontmatter present and valid”. Update the report’s “Validation Results” checklist to match the new no-frontmatter output format so the generated report isn’t self-contradictory.
Check the generated file:
- ✅ Markdown is valid
- ✅ Code blocks have language tags
- ✅ Mermaid diagrams render correctly
- ✅ No broken links
- ✅ Consistent tone throughout
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## 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`. |
There was a problem hiding this comment.
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
| 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`. |
| - **Repository**: ${{ github.repository }} | ||
| - **Specs Directory**: `scratchpad/` | ||
| - **Target File**: `.github/agents/developer.instructions.agent.md` | ||
| - **Target File**: `scratchpad/dev.md` |
There was a problem hiding this comment.
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.
| - **Target File**: `scratchpad/dev.md` | |
| - **Target File**: `scratchpad/developer.instructions.md` |
Relocates the developer-docs-consolidator workflow output from
.github/agents/developer.instructions.agent.mdtoscratchpad/dev.md, aligning input and output locations.Changes
.github/agents/developer.instructions.agent.mdtoscratchpad/dev.mdacross workflow phases (context, consolidation, validation, reporting)description,applyTofields) - output is now plain markdownRationale
The consolidated output is a development reference document, not an agent instruction file. Keeping both source specs and consolidated output in
scratchpad/simplifies the mental model and file organization.Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/github/gh-aw/actions/artifacts/5475309222/zip/usr/bin/curl curl -L -H Accept: application/vnd.github+json -H Authorization: ****** /tmp/artifact/agent-artifacts.zip REDACTED(http block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
This section details on the original issue you should resolve
<issue_title>[q] Update developer-docs-consolidator to write to scratchpad/dev.md</issue_title>
<issue_description># Q Workflow Optimization Report
Issue Analysis
Based on issue #14938 comment by @pelikhan requesting "/q update prompt to write file at scratchpad/dev.md", this PR updates the developer-docs-consolidator workflow to write its output to
scratchpad/dev.mdinstead of.github/agents/developer.instructions.agent.md.Changes Made
developer-docs-consolidator.md (.github/workflows/)
Updated all references to the target output file:
Target File Path (Line 71):
.github/agents/developer.instructions.agent.mdscratchpad/dev.mdConsolidated File Structure (Line 264):
All Prompt References:
Rationale
This change improves workflow consistency:
scratchpad/Expected Improvements
Validation
Workflow compiled successfully:
.github/workflows/developer-docs-consolidator.lock.ymlReferences
Triggered by: Issue Developer Documentation Consolidation - 2026-02-11 #14938, comment by @pelikhan
Command:
/q update prompt to write file at scratchpad/dev.mdWorkflow analyzed: developer-docs-consolidator.md
Fixes Developer Documentation Consolidation - 2026-02-11 #14938
To apply the patch locally:
Show patch preview (118 of 118 lines)