docs: update plan parser PR metadata fields [doc-updater] - #2783
Conversation
The yaml-tasks schema (#2779) now validates test_plan, manual_steps, context_title, and context_description in the pr: block. Update the architecture README to list all supported fields instead of only "title and description".
There was a problem hiding this comment.
Approve. Accurate documentation-only change.
Verified the new field list against all three sources of truth:
- Schema (
.egg/schemas/yaml-tasks.schema.json): thepr:object defines exactlytitle,description,test_plan,manual_steps,context_title,context_descriptionwithadditionalProperties: false. The doc's new list matches the schema exactly, including order. - Parser (
shared/egg_contracts/plan_parser.py):extract_pr_metadata_from_yamlextractstitle/description/test_plan/manual_steps, and_extract_context_pr_metadataextractscontext_title/context_description.ParsedPlancarries all six (pr_title,pr_description,pr_test_plan,pr_manual_steps,pr_context_title,pr_context_description). So "the parser also extracts" holds for all six fields. - Template (
docs/templates/plan.md): thepr:example block uses all six fields.
No blocking issues.
Non-blocking nuance: the trailing sentence — "this metadata is used when creating the pull request during the implement phase" — is slightly imprecise for context_title/context_description. Per their schema descriptions, those two feed the dedicated context PR (#2548), a separate PR, not the implementation PR. The sentence is pre-existing and broadly correct for the other four fields, so this is purely an optional precision improvement (e.g. "...used when creating the pull request — and the dedicated context PR — during the implement phase").
— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Review feedback addressedThanks for the review. Both reviews approved; one non-blocking suggestion was actionable.
— Authored by egg |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Approve. The non-blocking suggestion from the prior review is properly addressed.
Delta reviewed
Single-line change in docs/architecture/README.md (commit 77064a7), adding to the trailing sentence:
...the
context_titleandcontext_descriptionfields feed the dedicated context PR rather than the implementation PR.
Verification
The added clause is accurate against both sources of truth:
- Schema (
.egg/schemas/yaml-tasks.schema.json:50-56):context_title/context_descriptionare documented as "Optional title/description for the dedicated context PR (#2548). When omitted, the context PR reusespr.title/pr.description." - Parser (
shared/egg_contracts/plan_parser.py:1140-1144): the_extract_context_pr_metadatadocstring states the planner emits these fields "for the context PR's framing" — a separate PR from the implementation PR.
The distinction between the implementation PR and the dedicated context PR (#2548) is now explicit, which was exactly the imprecision flagged previously. No new issues introduced — the sentence is grammatically correct and the rest of the paragraph is unchanged.
No blocking issues. Docs-only change, no code paths affected.
— Authored by egg
There was a problem hiding this comment.
No agent-mode design concerns.
Re-reviewed the delta since commit 48c081d (one commit, 77064a7): a one-line clarification in docs/architecture/README.md noting that context_title/context_description feed the dedicated context PR rather than the implementation PR. This addresses the prior non-blocking precision suggestion. Still purely documentation — no changes to prompts, agent workflows, output formats, or LLM invocation paths.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
|
egg agent-mode-design completed. View run logs 5 previous review(s) hidden. |
docs: Update plan parser PR metadata field list in architecture README
Update documentation to reflect changes from 4aa3c91 (Fix #2756):
pr:block in yaml-tasks now validatestest_plan,manual_steps,context_title, andcontext_descriptionin addition totitleanddescription(per the updated.egg/schemas/yaml-tasks.schema.json)Triggered by: #2779
Test Plan
.egg/schemas/yaml-tasks.schema.jsonand the example indocs/templates/plan.mdAuthored-by: egg