Skip to content

Commit ae3de6f

Browse files
docs: tone scan v5.7 — fix 4 marketing language issues in 2 spec files (#25617)
1 parent 58dc289 commit ae3de6f

3 files changed

Lines changed: 8 additions & 7 deletions

File tree

scratchpad/dev.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Developer Instructions
22

3-
**Version**: 5.6
4-
**Last Updated**: 2026-04-09
3+
**Version**: 5.7
4+
**Last Updated**: 2026-04-10
55
**Purpose**: Consolidated development guidelines for GitHub Agentic Workflows
66

77
This document consolidates specifications from the scratchpad directory into unified developer instructions. It provides architecture patterns, security guidelines, code organization rules, and testing practices.
@@ -2777,7 +2777,7 @@ These files are loaded automatically by compatible AI tools (e.g., GitHub Copilo
27772777
- [Gastown Multi-Agent Analysis](./gastown.md) - Conceptual mapping of Gastown orchestration patterns (persistent state, crash recovery, structured handoffs) to gh-aw concepts
27782778
- [mdflow Deep Research](./mdflow.md) - Technical comparison of mdflow and gh-aw: custom engine opportunities, template variable patterns, and import mechanism differences
27792779
- [mdflow Syntax Comparison](./mdflow-comparison.md) - Detailed comparison of mdflow and gh-aw syntax covering 17 aspects: file naming, frontmatter design, templates, imports, security models, and execution patterns
2780-
- [oh-my-opencode Comparison](./oh-my-code.md) - Deep research comparison of oh-my-opencode and gh-aw: architecture, use cases, tool ecosystems, security models, and implementation patterns
2780+
- [oh-my-opencode Comparison](./oh-my-code.md) - Technical comparison of oh-my-opencode and gh-aw: architecture, use cases, tool ecosystems, security models, and implementation patterns
27812781
- [Agent Sessions Terminology Migration](./agent-sessions.md) - Migration plan for renaming "agent task" to "agent session": schema updates, codemod in `fix_codemods.go`, Go/JavaScript code changes, documentation updates, and backward compatibility strategy
27822782
- [Safe Output Handler Factory Pattern](./safe-output-handlers-refactoring.md) - Refactoring status for all 11 safe output handlers to the handler factory pattern (`main(config)` returns a message handler function): per-handler status, testing strategy, and handler manager compatibility
27832783
- [Serena Tools Statistical Analysis](./serena-tools-analysis.md) - Deep statistical analysis of Serena MCP tool usage in workflow run 21560089409: tool adoption rates (26% of registered tools used), call distributions, and unused tool identification
@@ -2795,6 +2795,7 @@ These files are loaded automatically by compatible AI tools (e.g., GitHub Copilo
27952795
---
27962796

27972797
**Document History**:
2798+
- v5.7 (2026-04-10): Maintenance tone scan — fixed 4 tone issues across 2 spec files: `oh-my-code.md` (3 fixes: "Deep Research Comparison"→"Technical Comparison", "Comprehensive Analysis"→"Analysis", "deep research comparison between"→"compares"), `mdflow-comparison.md` (1 fix: "detailed syntax comparison"→"syntax comparison"). Updated Related Documentation description for `oh-my-code.md`. Coverage: 75 spec files (no new files).
27982799
- v5.6 (2026-04-09): Fixed 4 broken links in `scratchpad/README.md` (case-sensitive file name corrections: `MCP_LOGS_GUARDRAIL.md``mcp_logs_guardrails.md`, `SCHEMA_VALIDATION.md``schema-validation.md`, `SECURITY_REVIEW_TEMPLATE_INJECTION.md``security_review.md`; `campaigns-files.md` marked removed). Fixed 3 tone issues in `README.md` ("Detailed comparison"→"Comparison", "Detailed analysis"→"Analysis", "Complete deep-dive statistical analysis"→"Statistical analysis"). Updated `README.md` last-updated date. Added `README.md` to Related Documentation. Coverage: 75 spec files (no new files).
27992800
- v5.5 (2026-04-08): Added WorkQueueOps and BatchOps design pattern subsections to Workflow Patterns (from PR #25178: four queue strategies — issue checklist, sub-issues, cache-memory, discussion-based; four batch strategies — chunked, matrix fan-out, rate-limit-aware, result aggregation). Added 2 new Related Documentation links for `docs/src/content/docs/patterns/workqueue-ops.md` and `batch-ops.md`. Coverage: 75 spec files (2 new pattern docs).
28002801
- v5.4 (2026-04-07): Added `gh-aw.github.rate_limit.reset` OTLP span attribute to GitHub API Rate Limit Observability section (from PR #25061: ISO 8601 reset timestamp now included in conclusion spans). Coverage: 73 spec files (no new spec files).

scratchpad/mdflow-comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Executive Summary
88

9-
This document provides a detailed syntax comparison between mdflow and GitHub Agentic Workflows (gh-aw). Both projects enable AI-driven automation through markdown files, but they target different use cases and have different design philosophies.
9+
This document compares the syntax of mdflow and GitHub Agentic Workflows (gh-aw). Both projects enable AI-driven automation through markdown files, but they target different use cases and have different design philosophies.
1010

1111
### Key Differences at a Glance
1212

scratchpad/oh-my-code.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# oh-my-opencode vs GitHub Agentic Workflows: Deep Research Comparison
1+
# oh-my-opencode vs GitHub Agentic Workflows: Technical Comparison
22

33
**Date**: 2026-01-05
44
**oh-my-opencode Repository**: https://github.com/code-yeongyu/oh-my-opencode
55
**GitHub Agentic Workflows Repository**: https://github.com/github/gh-aw
6-
**Status**: Comprehensive Analysis
6+
**Status**: Analysis
77

88
## Executive Summary
99

10-
This document provides a deep research comparison between **oh-my-opencode** and **GitHub Agentic Workflows** (gh-aw). Both projects represent recent approaches to AI-powered software development automation, but they target fundamentally different use cases, execution environments, and philosophies.
10+
This document compares **oh-my-opencode** and **GitHub Agentic Workflows** (gh-aw). Both projects represent recent approaches to AI-powered software development automation, but they target fundamentally different use cases, execution environments, and philosophies.
1111

1212
### Key Differences at a Glance
1313

0 commit comments

Comments
 (0)