Skip to content

Commit 2481203

Browse files
authored
Merge pull request #39 from flightctl/andalton/agentic-alignment
Trim AGENTS.md to align with best practices (369 → 122 lines)
2 parents a0c7166 + 1ef5ee0 commit 2481203

4 files changed

Lines changed: 53 additions & 281 deletions

File tree

.github/scripts/validate-structure.sh

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -111,17 +111,7 @@ for wf in "${workflows[@]}"; do
111111
fail "AGENTS.md: workflow list missing entry for '$wf'"
112112
fi
113113

114-
# 5b. Artifact management (lines like: - **workflow**: `.artifacts/...)
115-
if ! grep -qF -- "- **${wf}**:" "$agents"; then
116-
fail "AGENTS.md: artifact management missing entry for '$wf'"
117-
fi
118-
119-
# 5c. Workflow-Specific Notes (### heading)
120-
if ! grep -qF -- "### ${wf}" "$agents"; then
121-
fail "AGENTS.md: workflow-specific notes missing '### $wf' section"
122-
fi
123-
124-
# 5d. File organization tree (line containing the workflow dir name)
114+
# 5b. File organization tree (line containing the workflow dir name)
125115
if ! sed -n '/^```text/,/^```/p' "$agents" | grep -qF -- "${wf}/"; then
126116
fail "AGENTS.md: file organization tree missing '$wf/'"
127117
fi
@@ -143,7 +133,20 @@ done
143133
echo
144134

145135
# ---------------------------------------------------------------------------
146-
# 7. No absolute paths in skill files
136+
# 7. Per-workflow README.md artifact documentation
137+
# ---------------------------------------------------------------------------
138+
echo "--- Workflow README artifact docs ---"
139+
for wf in "${workflows[@]}"; do
140+
readme_wf="$wf/README.md"
141+
[ -f "$readme_wf" ] || continue
142+
if ! grep -qF '.artifacts/' "$readme_wf"; then
143+
fail "$readme_wf: missing artifact path documentation (.artifacts/ reference)"
144+
fi
145+
done
146+
echo
147+
148+
# ---------------------------------------------------------------------------
149+
# 8. No absolute paths in skill files
147150
# ---------------------------------------------------------------------------
148151
echo "--- Absolute path check ---"
149152
for wf in "${workflows[@]}"; do

0 commit comments

Comments
 (0)