Repository navigation
docs: preserve reusable recipe drafting guidance - #965
Merged
Merged
Conversation
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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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>
Contributor
There was a problem hiding this comment.
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>
Contributor
|
@rachaelrenk, your GitHub account is not connected to Warp. Connect your GitHub account. |
|
@rachaelrenk, your GitHub account is not connected to Warp. Connect your GitHub account. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
AGENTS.mdas the authoritative home for task-first field instructions, coherent setup phases, existing-resource paths, configuration/access versus skill instructions, and safety beside copyable actions.draft_docs,review-docs-pr, andaeo_brief, plus bracketed hints in the procedural and feature templates..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 --checkpassed.17b29842. Both variants received identical fixed-fact editing prompts, with grading assertions withheld.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