Conversation
… (v3.4) - Added Package Structure section under Core Architecture (from scratchpad/architecture.md, updated 2026-03-01): layered package table covering entry points, core packages (pkg/cli, pkg/workflow, pkg/parser, pkg/console), shared definitions (pkg/constants, pkg/types), and utility packages - Added GitHub MCP Guard Policies section under MCP Integration (from scratchpad/guard-policies-specification.md): frontmatter syntax, repos scope patterns, min-integrity levels, validation location, and extensibility notes - Added 2 Related Documentation links for architecture.md and guard-policies-specification.md - Updated version to v3.4, date to 2026-03-01, and document history Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
pelikhan
approved these changes
Mar 2, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates scratchpad/dev.md to v3.4 by consolidating additional architecture and MCP policy specifications into the unified developer instructions.
Changes:
- Added a “Package Structure” section summarizing the layered package layout (entry points, core/shared packages, utilities).
- Added a “GitHub MCP Guard Policies” section documenting
repos/min-integrityfrontmatter and where validation occurs. - Added related-documentation links and a v3.4 document history entry.
Comments suppressed due to low confidence (3)
scratchpad/dev.md:124
- The section says the package structure has "three tiers" (entry points, core, utilities), but it also introduces a separate "Shared Definitions" grouping. This is internally inconsistent—either update the text to describe four groupings (entry points/core/shared/utilities) or fold shared definitions into one of the three tiers so the description matches the table that follows.
The codebase uses a layered package structure with three tiers: entry points, core packages, and utilities.
**Entry Points**: `cmd/gh-aw` (main CLI binary) and `cmd/gh-aw-wasm` (WebAssembly target)
**Core Packages**:
| Package | Description |
|---------|-------------|
| `pkg/cli` | CLI command implementations and subcommands |
| `pkg/workflow` | Workflow compilation engine and orchestration |
| `pkg/parser` | Markdown frontmatter and YAML parsing |
| `pkg/console` | Terminal UI and styled output rendering |
**Shared Definitions**:
scratchpad/dev.md:134
- This path is misleading in the context of
scratchpad/dev.md:architecture.mdlives in the same directory, so the accurate relative reference would be./architecture.md(or justarchitecture.md). As written,scratchpad/architecture.mdimplies a nestedscratchpad/scratchpad/path.
This issue also appears on line 1730 of the same file.
See `scratchpad/architecture.md` for the full package dependency diagram.
scratchpad/dev.md:1730
- Similar to the earlier architecture reference, this points to
scratchpad/guard-policies-specification.mdeven though the file is already inscratchpad/. Consider changing the reference to./guard-policies-specification.md(orguard-policies-specification.md) to avoid implying a nestedscratchpad/scratchpad/path and to match the link style used in the Related Documentation section.
See `scratchpad/guard-policies-specification.md` for the full specification including type hierarchy and error message reference.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Analyzed 63 markdown files in
scratchpad/(2 new since 2026-02-28 run). 0 tone issues and 0 formatting issues found. 2 new spec files incorporated intoscratchpad/dev.md.Changes Made
scratchpad/dev.md— version v3.3 → v3.4 (+67 lines, 2074 → 2139)New: Package Structure section (Core Architecture)
Sourced from
scratchpad/architecture.md(last updated 2026-03-01). Added a layered package reference table:cmd/gh-awandcmd/gh-aw-wasmpkg/cli,pkg/workflow,pkg/parser,pkg/consolepkg/constants,pkg/typesNew: GitHub MCP Guard Policies section (MCP Integration)
Sourced from
scratchpad/guard-policies-specification.md. Covers:repos+min-integrityfields)"all","public", array ofowner/repopatterns)none|reader|writer|merged)Supporting updates
Coverage
✅ 100% — all 62 spec files documented (63 analyzed: 62 spec + 1 test artifact)
Validation
✅ Markdown syntax valid
✅ 9 Mermaid diagrams retained
✅ All code blocks have language tags
✅ Technical tone consistent throughout
References: