Skip to content

Trim AGENTS.md to align with best practices (369 → 122 lines) #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adalton merged 2 commits into from
May 8, 2026
+53 −281
Merged

Trim AGENTS.md to align with best practices (369 → 122 lines) #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7f19b2
Trim AGENTS.md from 369 to 122 lines
adalton May 7, 2026
1ef5ee0
Fix CI validator and address CodeRabbit feedback
adalton May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions .github/scripts/validate-structure.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,17 +111,7 @@ for wf in "${workflows[@]}"; do
fail "AGENTS.md: workflow list missing entry for '$wf'"
fi

# 5b. Artifact management (lines like: - **workflow**: `.artifacts/...)
if ! grep -qF -- "- **${wf}**:" "$agents"; then
fail "AGENTS.md: artifact management missing entry for '$wf'"
fi

# 5c. Workflow-Specific Notes (### heading)
if ! grep -qF -- "### ${wf}" "$agents"; then
fail "AGENTS.md: workflow-specific notes missing '### $wf' section"
fi

# 5d. File organization tree (line containing the workflow dir name)
# 5b. File organization tree (line containing the workflow dir name)
if ! sed -n '/^```text/,/^```/p' "$agents" | grep -qF -- "${wf}/"; then
fail "AGENTS.md: file organization tree missing '$wf/'"
fi
Expand All @@ -143,7 +133,20 @@ done
echo

# ---------------------------------------------------------------------------
# 7. No absolute paths in skill files
# 7. Per-workflow README.md artifact documentation
# ---------------------------------------------------------------------------
echo "--- Workflow README artifact docs ---"
for wf in "${workflows[@]}"; do
readme_wf="$wf/README.md"
[ -f "$readme_wf" ] || continue
if ! grep -qF '.artifacts/' "$readme_wf"; then
fail "$readme_wf: missing artifact path documentation (.artifacts/ reference)"
fi
done
echo

# ---------------------------------------------------------------------------
# 8. No absolute paths in skill files
# ---------------------------------------------------------------------------
echo "--- Absolute path check ---"
for wf in "${workflows[@]}"; do
Expand Down
Loading
Loading