Skip to content

Commit aa358a3

Browse files
docs: fix broken links and tone in scratchpad/README.md, bump dev.md to v5.6 (#25446)
1 parent dd9d0d2 commit aa358a3

2 files changed

Lines changed: 12 additions & 10 deletions

File tree

scratchpad/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This directory contains design specifications and implementation documentation f
1010
| [Validation Architecture](./validation-architecture.md) | ✅ Documented | `pkg/workflow/validation.go` and domain-specific files |
1111
| [Go Type Patterns and Best Practices](./go-type-patterns.md) | ✅ Documented | `pkg/constants/constants.go`, `pkg/workflow/permissions_validator.go`, `pkg/parser/frontmatter.go` |
1212
| [Styles Guide](./styles-guide.md) | ✅ Documented | `pkg/styles/theme.go` - Adaptive color palette and terminal styling |
13-
| [Campaign Files Architecture](./campaigns-files.md) | ✅ Documented | `pkg/campaign/`, `actions/setup/js/campaign_discovery.cjs` - Campaign discovery, compilation, and execution |
13+
| [Campaign Files Architecture](./campaigns-files.md) | 📋 File removed | `pkg/campaign/`, `actions/setup/js/campaign_discovery.cjs` - Campaign discovery, compilation, and execution |
1414

1515
## Specifications
1616

@@ -20,30 +20,30 @@ This directory contains design specifications and implementation documentation f
2020
| [Capitalization Guidelines](./capitalization.md) | ✅ Documented | `cmd/gh-aw/capitalization_test.go` |
2121
| [Safe Output Messages Design System](./safe-output-messages.md) | ✅ Implemented | `pkg/workflow/safe_outputs.go` |
2222
| [Safe Output Environment Variables Reference](./safe-output-environment-variables.md) | ✅ Documented | Environment variable requirements for safe output jobs |
23-
| [MCP Logs Guardrail](./MCP_LOGS_GUARDRAIL.md) | ✅ Implemented | `pkg/cli/mcp_logs_guardrail.go` |
23+
| [MCP Logs Guardrail](./mcp_logs_guardrails.md) | ✅ Implemented | `pkg/cli/mcp_logs_guardrail.go` |
2424
| [YAML Version Compatibility](./yaml-version-gotchas.md) | ✅ Documented | `pkg/workflow/compiler.go` |
25-
| [Schema Validation](./SCHEMA_VALIDATION.md) | ✅ Documented | `pkg/parser/schemas/` |
25+
| [Schema Validation](./schema-validation.md) | ✅ Documented | `pkg/parser/schemas/` |
2626
| [GitHub Actions Security Best Practices](./github-actions-security-best-practices.md) | ✅ Documented | Workflow security guidelines and patterns |
2727
| [End-to-End Feature Testing](./end-to-end-feature-testing.md) | ✅ Documented | `.github/workflows/dev.md`, `.github/workflows/dev-hawk.md` |
2828

2929
## Security Reviews
3030

3131
| Document | Date | Status |
3232
|----------|------|--------|
33-
| [Template Injection Security Review](./SECURITY_REVIEW_TEMPLATE_INJECTION.md) | 2025-11-11 | ✅ No vulnerabilities found |
33+
| [Template Injection Security Review](./security_review.md) | 2025-11-11 | ✅ No vulnerabilities found |
3434

3535
## Comparative Analysis
3636

3737
| Document | Status | Description |
3838
|----------|--------|-------------|
39-
| [mdflow Syntax Comparison](./mdflow-comparison.md) | ✅ Documented | Detailed comparison of mdflow and gh-aw syntax covering 17 aspects: file naming, frontmatter design, templates, imports, security models, execution patterns, and more |
40-
| [Gastown Multi-Agent Orchestration](./gastown.md) | ✅ Documented | Detailed analysis of Gastown's multi-agent coordination patterns and mapping to gh-aw concepts: persistent state, workflow composition, crash recovery, agent communication, and implementation recommendations |
39+
| [mdflow Syntax Comparison](./mdflow-comparison.md) | ✅ Documented | Comparison of mdflow and gh-aw syntax covering 17 aspects: file naming, frontmatter design, templates, imports, security models, execution patterns, and more |
40+
| [Gastown Multi-Agent Orchestration](./gastown.md) | ✅ Documented | Analysis of Gastown's multi-agent coordination patterns and mapping to gh-aw concepts: persistent state, workflow composition, crash recovery, agent communication, and implementation recommendations |
4141

4242
## Statistical Analysis & Reports
4343

4444
| Document | Date | Description |
4545
|----------|------|-------------|
46-
| [Serena Tools Usage Analysis](./serena-tools-analysis.md) | 2026-02-01 |Complete deep-dive statistical analysis of Serena MCP server tool usage in workflow run 21560089409 |
46+
| [Serena Tools Usage Analysis](./serena-tools-analysis.md) | 2026-02-01 |Statistical analysis of Serena MCP server tool usage in workflow run 21560089409 |
4747
| [Serena Tools Quick Reference](./serena-tools-quick-reference.md) | 2026-02-01 | ✅ At-a-glance summary of Serena tool usage metrics and insights |
4848
| [Serena Tools Raw Data](./serena-tools-data.json) | 2026-02-01 | ✅ JSON dataset with complete statistics for programmatic access |
4949

@@ -63,4 +63,4 @@ When adding new specifications:
6363

6464
---
6565

66-
**Last Updated**: 2026-01-20
66+
**Last Updated**: 2026-04-09

scratchpad/dev.md

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

3-
**Version**: 5.5
4-
**Last Updated**: 2026-04-08
3+
**Version**: 5.6
4+
**Last Updated**: 2026-04-09
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.
@@ -2720,6 +2720,7 @@ These files are loaded automatically by compatible AI tools (e.g., GitHub Copilo
27202720

27212721
### Related Documentation
27222722

2723+
- [Scratchpad Index](./README.md) - Directory index of all specification and documentation files in the `scratchpad/` directory with status and implementation references
27232724
- [Safe Outputs Specification](./safe-outputs-specification.md) - W3C-style formal specification
27242725
- [Validation Architecture](./validation-architecture.md) - Detailed validation patterns
27252726
- [GitHub Actions Security](./github-actions-security-best-practices.md) - Security guidelines
@@ -2794,6 +2795,7 @@ These files are loaded automatically by compatible AI tools (e.g., GitHub Copilo
27942795
---
27952796

27962797
**Document History**:
2798+
- 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).
27972799
- 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).
27982800
- 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).
27992801
- v5.3 (2026-04-05): Added GitHub API Rate Limit Observability subsection to MCP Integration (from PR #24694: `github_rate_limit_logger.cjs`, `GithubRateLimitsFilename` constant, artifact upload paths, OTLP span enrichment). Created new spec file `scratchpad/github-rate-limit-observability.md`. Added 1 new Related Documentation link. Coverage: 73 spec files (1 new).

0 commit comments

Comments
 (0)