Skip to content

docs: preserve reusable recipe drafting guidance - #965

Merged
rachaelrenk merged 3 commits into
mainfrom
rrenk/recipe-drafting-guidance
Oct 29, 2026
Merged

rachaelrenk merged 3 commits into
mainfrom
rrenk/recipe-drafting-guidance

Conversation

@rachaelrenk

Copy link
Copy Markdown
Contributor

Summary

Preserves reusable lessons from the combined factory-recipe review in #895 without coupling the guidance changes to that content stack. This PR changes internal Docs guidance and evaluation inputs only; it adds no public product claims or runtime behavior.

Changes

  • Strengthens AGENTS.md as the authoritative home for task-first field instructions, coherent setup phases, existing-resource paths, configuration/access versus skill instructions, and safety beside copyable actions.
  • Adds composed-workflow review guidance for overlapping triggers, cumulative exclusions, handoffs, stopping points, and continued-conversation ownership.
  • Keeps standalone answers naturally attributable while separating measured umbrella signals from unmeasured topic-level recommendations.
  • Adds concise pointers in draft_docs, review-docs-pr, and aeo_brief, plus bracketed hints in the procedural and feature templates.
  • Corrects the procedural template's prerequisite example to use the existing unbolded-bullet convention.
  • Adds four fixed-fact editing cases at .agents/skills/draft_docs/evals/evals.json, with 28 assertions.

Factory-specific labels, routing semantics, credentials, and deployment facts remain in product references rather than universal style rules. No public recipe pages or serializer code are included.

Validation and evaluation

  • test_editorial_guidance.py: 8 tests passed.
  • test_publishing_snippet.py: 4 tests passed.
  • git diff --check passed.
  • Checked template bracket conventions, unchanged skill names/frontmatter, canonical guidance pointers, and evaluation JSON structure.
  • Original guidance was snapshotted before editing and checked against base 17b29842. Both variants received identical fixed-fact editing prompts, with grading assertions withheld.
  • Four cases cover alternate-name task-first procedures, verifier setup boundaries, stateful Jira routing, and AEO attribution/evidence scope.
  • Both original and updated guidance passed 27/28 assertions. Both omitted the exact two umbrella signal names from the editorial rationale in the fourth case. This is narrow regression coverage, not evidence of a general quality improvement.
  • Updated outputs grouped some setup steps more tightly, but fewer steps is not itself better prose. Human readability review remains necessary.

The static reviewer, eight output drafts, and grading/benchmark JSON remain local under /tmp/docs-drafting-guidance-eval/; they are not portable CI artifacts or committed generated reports. Only the reusable evaluation inputs are committed. There was one drafting batch per variant and one sample per case; shared inherited rules, highly directed prompts, and within-batch context limit causal conclusions. Timing and token metrics were unavailable and were not invented.

Documentation risk

Risk: low
Rationale: Internal Docs-team skill, style-guide, template, and evaluation-input maintenance only; no public product claims or developer-facing command, API, setting, integration, or runtime behavior changes.
Docs override: none

Unverified claims

No new public product claims. Fixed-fact evaluation examples are editing fixtures, not live product verification. Broader drafting-quality improvement is unmeasured.

Review focus

Check that the rules generalize beyond the factory recipes, retain necessary instructional context without adding boilerplate, and keep canonical policy in AGENTS.md. The paired examples are available in the local review viewer for qualitative review.

No reviewer was requested: this internal Docs guidance change has no uniquely resolved owning engineer.

Related content fixes: #895

Implementation and evaluation context: https://staging.warp.dev/conversation/022d43d0-010c-4bc2-b6b7-58523e50176a

Co-Authored-By: Warp agent@warp.dev

Strengthen task-first procedures, configuration and access boundaries, composed workflow review, and evidence-scoped AEO. Add four fixed-fact drafting regression cases.

Co-Authored-By: Warp <agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Oct 28, 2026
@vercel

vercel Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 28, 2026 10:32pm UTC

Request Review

Replace compressed guidance with concrete setup and workflow checks, clarify search-evidence requirements, and add structural regression coverage.

Co-Authored-By: Warp <agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Oct 28, 2026
@warp-agent-staging warp-agent-staging Bot added the factory:docs-factory Label associated to the "docs-factory" factory label Oct 28, 2026

@warp-agent-staging warp-agent-staging Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No blocking findings at 88abf6e; the setup, safety, and evidence-scope guidance is consistent with this internal-only change. All 12 editorial-guidance tests and 4 publishing-snippet tests pass; two CI checks are still running. Approving with one nonblocking test-maintenance suggestion below.

Responding as Docs Factory (V2): Open session · View in factory

Require the connected-procedures link explicitly, allow other valid AGENTS.md anchors, and cover missing or invalid link targets.

Co-Authored-By: Warp <agent@warp.dev>
@rachaelrenk
rachaelrenk merged commit beb2f07 into main Oct 29, 2026
11 of 12 checks passed
@rachaelrenk
rachaelrenk deleted the rrenk/recipe-drafting-guidance branch October 29, 2026 19:22
@warp-agent-staging

Copy link
Copy Markdown
Contributor

@rachaelrenk, your GitHub account is not connected to Warp. Connect your GitHub account.

@warp-local-for-testing-only

Copy link
Copy Markdown

@rachaelrenk, your GitHub account is not connected to Warp. Connect your GitHub account.

This branch was successfully deployed

1 active deployment
Preview — 40a322bd Deployed Oct 28, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed factory:docs-factory Label associated to the "docs-factory" factory warpy-factory Opened by the Warp factory agents

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant