Skip to content

[instructions] Sync instruction files — document comment-memory in memory.md#30555

Merged
pelikhan merged 1 commit into
mainfrom
instructions/sync-comment-memory-docs-67ebc431bc8c785f
May 6, 2026
Merged

[instructions] Sync instruction files — document comment-memory in memory.md#30555
pelikhan merged 1 commit into
mainfrom
instructions/sync-comment-memory-docs-67ebc431bc8c785f

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 6, 2026

Instructions Update — comment-memory documentation gap

This PR fills a documentation gap in .github/aw/memory.md. syntax.md explicitly references memory.md for detailed documentation of comment-memory, but memory.md had no such section.

Files Changed

  • memory.md: Added comment-memory documentation — Quick Decision Guide row, full configuration/how-it-works section, and Summary Comparison table column.

What was missing

syntax.md (line 656) states:

Memory configuration: For detailed documentation on cache-memory:, repo-memory:, and comment-memory: configuration including advanced options and use cases, see memory.md.

But memory.md documented only cache-memory and repo-memory. The comment-memory section was absent.

Documentation Commits Reviewed

The repository is a shallow clone (single commit); safe-outputs code audit was performed against pkg/workflow/comment_memory.go and pkg/workflow/compiler_types.go.

Size Audit

File Before After Status
memory.md 352 lines 402 lines ✓ (soft limit: 500)
github-agentic-workflows.md 193 lines 193 lines
safe-outputs.md 994 lines 994 lines
syntax.md 932 lines 932 lines

Validation

  • Followed prompting best practices (imperative mood, minimal examples)
  • Maintained technical tone and brevity
  • Updated the correct file (memory.md) — not the main file
  • No content duplication introduced between files
  • File sizes within target limits
  • Verified accuracy against pkg/workflow/comment_memory.go

🤖 Generated with [Claude Code]((claude.com/redacted)

Generated by Instructions Janitor · ● 844.7K ·

  • expires on May 8, 2026, 9:23 AM UTC

Document the comment-memory tool under tools: in memory.md, filling a
gap referenced by syntax.md. Adds the section to the Quick Decision
Guide, a full configuration/how-it-works reference, and a column in
the Summary Comparison table.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation instructions labels May 6, 2026
@github-actions
Copy link
Copy Markdown
Contributor Author

github-actions Bot commented May 6, 2026

Hey @app/github-actions 👋 — great catch on the comment-memory documentation gap in memory.md! Filling in the missing section that syntax.md already cross-references is exactly the kind of consistency fix that keeps the instruction files trustworthy for agents relying on them.

One small flag before this lands:

  • No test files changed — While this is a documentation-only PR and runtime tests may not be directly applicable, the project may have doc-linting, link-checking, or instruction-validation steps that should be exercised. If any such checks exist (e.g. in scripts/ or CI workflows), confirming they pass or adding a note that they were verified would strengthen confidence here.

If you'd like a hand addressing this:

Review the CI/CD configuration for github/gh-aw to identify any documentation linting, link-checking, or instruction validation steps that apply to .github/aw/memory.md. Confirm that PR #30555 (adding the comment-memory section to memory.md) passes all relevant checks, and if any automated validation scripts exist, run them and report the results.

Generated by Contribution Check · ● 6.6M ·

@pelikhan pelikhan merged commit 03b2ddb into main May 6, 2026
@pelikhan pelikhan deleted the instructions/sync-comment-memory-docs-67ebc431bc8c785f branch May 6, 2026 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation instructions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant