docs(#345): prioritize user-focused documentation - #389
Conversation
Restructure all 7 agent doc files to separate content by audience. Each file now follows a consistent hierarchy: User section (top) — triggers, commands, control labels, and observable behavior with no references to scripts, JSON, sandboxes, schemas, or internal mechanics. Configuration section (middle) — skill overrides, env vars, and behavior tuning for admins. How the agent works section (bottom) — architecture and implementation details for developers. Key changes across all files: - Add dedicated Triggers section extracting activation events from prose into a scannable list - Move "How the agent works" from top to bottom - Remove internal terms (post-script, sandbox, JSON, schema, harness) from user-facing sections - Rename "Configuration and extension" to "Configuration" - Clean control label descriptions to describe behavior without exposing implementation mechanics For fix.md specifically, extract user-facing content (what the agent reads, URL limitations, iteration limits) from the internals section into the user section with internal terms replaced by user-friendly language. Closes #345
rh-hemartin
left a comment
There was a problem hiding this comment.
I think it did well here, LGTM
|
/fs-review |
|
🤖 Finished Review · ✅ Success · Started 8:23 AM UTC · Completed 8:45 AM UTC |
ReviewFindingsLow
Labels: PR modifies documentation files exclusively (docs/*.md) |
|
/fs-fix |
|
🤖 Finished Fix · ✅ Success · Started 1:06 PM UTC · Completed 1:12 PM UTC |
- triage.md: add missing Configuration boilerplate and Variables subsection - fix.md: soften pipeline cross-reference to "similar pipeline" since fix has a 4-step pipeline vs code agent's 3-step - review.md: restore dual-filter defense-in-depth description for severity threshold variable - code.md: use active voice with agent attribution for ready-for-review label - review.md: use active voice for rejected label description Addresses review feedback on #389
🔧 Fix agent — iteration 1 (human-triggered)Addressed all 5 review findings: added missing boilerplate and Variables subsection to triage.md, softened fix.md pipeline cross-reference, restored dual-filter defense-in-depth info in review.md, and fixed voice consistency in code.md and review.md control label tables. Fixed (5):
Tests: passed Updated by fullsend fix agent |
deboer-tim
left a comment
There was a problem hiding this comment.
Two minor comments it would be good to address, but overall this is much better separation and avoids using implementation details in the end-user docs. 👍🏼
|
/fs-fix |
|
🤖 Finished Fix · ✅ Success · Started 6:56 AM UTC · Completed 7:01 AM UTC |
- code.md: remove automatic/manual distinction from Triggers section;
both label-apply and /fs-code are human-initiated, present them equally
- scribe.md: clarify summary line per reviewer suggestion ("adds comments
to relevant issues or creates new issues")
Addresses review feedback on #389
🔧 Fix agent — iteration 2 (human-triggered)Addressed 2 reviewer nits from deboer-tim: removed false automatic/manual distinction in code.md Triggers section, and clarified scribe.md summary line. Fixed (2):
Tests: passed Updated by fullsend fix agent |
|
🤖 Finished Retro · ✅ Success · Started 7:16 AM UTC · Completed 7:29 AM UTC |
Retro: PR #389 — docs(#345): prioritize user-focused documentationTimeline
Total agent cost: ~$11.73 across 4 agent invocations (~35 min active time). AssessmentThis workflow executed well. The triage agent produced clear, specific guidance with concrete validation criteria. The code agent delivered solid initial work across 7 files. The review agent found 5 valid low-severity issues — all actionable, none false positives. The fix agent addressed both automated review findings and human reviewer nits efficiently across two iterations. The human reviewer (deboer-tim) contributed 2 editorial nits: (1) the code agent introduced a misleading distinction between "automatic" label triggers and "manual" Evidence for existing open issues
Proposals filed
|
Summary
Restructures all 7 agent documentation files (
docs/*.md) to separate content by audience:Changes
post-script,sandbox,JSON,schema,harness,structured output,OpenShell) from user-facing sectionsfix.md: extracted user-facing content (what the agent reads, URL limitations, iteration limits) from the internals section into the user section with internal terms replaced by user-friendly languageAll information is preserved — internal details are relocated to the bottom of each file, not removed.
Test plan
prerequisites-creates-allowed-issuetest failure inpost-triage-test.shis unrelated to documentation changes (fails onmainas well)Closes #345
Post-script verification
agent/345-user-focused-docs)0bb70d1e627c86c108c2ecfd7fae8b52df2c1c5c..HEAD)