Skip to content

docs: update plan parser PR metadata fields [doc-updater] - #2783

Merged
jwbron merged 2 commits into
mainfrom
egg/doc-update-yaml-tasks-pr-fields
May 22, 2026
Merged

docs: update plan parser PR metadata fields [doc-updater]#2783
jwbron merged 2 commits into
mainfrom
egg/doc-update-yaml-tasks-pr-fields

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

docs: Update plan parser PR metadata field list in architecture README

Update documentation to reflect changes from 4aa3c91 (Fix #2756):

  • The pr: block in yaml-tasks now validates test_plan, manual_steps, context_title, and context_description in addition to title and description (per the updated .egg/schemas/yaml-tasks.schema.json)
  • The architecture README's plan parser description only listed "title and description", making it inaccurate

Triggered by: #2779

Test Plan

  • Automated: no tests for docs
  • Manual: confirm the updated sentence accurately reflects the schema fields validated in .egg/schemas/yaml-tasks.schema.json and the example in docs/templates/plan.md

Authored-by: egg

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".

@egg-reviewer egg-reviewer 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 agent-mode design concerns. This is a one-line documentation update to the plan parser description in the architecture README — no changes to prompts, agent workflows, output formats, or LLM invocation paths.

— Authored by egg

@egg-reviewer egg-reviewer 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.

Approve. Accurate documentation-only change.

Verified the new field list against all three sources of truth:

  • Schema (.egg/schemas/yaml-tasks.schema.json): the pr: object defines exactly title, description, test_plan, manual_steps, context_title, context_description with additionalProperties: false. The doc's new list matches the schema exactly, including order.
  • Parser (shared/egg_contracts/plan_parser.py): extract_pr_metadata_from_yaml extracts title/description/test_plan/manual_steps, and _extract_context_pr_metadata extracts context_title/context_description. ParsedPlan carries 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): the pr: 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

@james-in-a-box

This comment has been minimized.

@james-in-a-box

This comment has been minimized.

@james-in-a-box

This comment has been minimized.

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

Review feedback addressed

Thanks for the review. Both reviews approved; one non-blocking suggestion was actionable.

  • Precision of the trailing sentence — context_title/context_description feed the dedicated context PR, not the implementation PR: fixed-in-PR (commit 77064a7). Updated the sentence to "...used when creating the pull request during the implement phase; the context_title and context_description fields feed the dedicated context PR rather than the implementation PR." This makes the distinction explicit without conflating the two PRs.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@egg-reviewer egg-reviewer 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.

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_title and context_description fields 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_description are documented as "Optional title/description for the dedicated context PR (#2548). When omitted, the context PR reuses pr.title/pr.description."
  • Parser (shared/egg_contracts/plan_parser.py:1140-1144): the _extract_context_pr_metadata docstring 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

@egg-reviewer egg-reviewer 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 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

@james-in-a-box

This comment has been minimized.

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg agent-mode-design completed. View run logs

5 previous review(s) hidden.

@jwbron
jwbron merged commit adb83f7 into main May 22, 2026
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Schema vs parser drift: yaml-tasks dependencies field type mismatch

1 participant