Skip to content

[bugfix][docs] Fix workflow agent quickstart code snippet and comment#808

Merged
wenjin272 merged 2 commits into
apache:mainfrom
Ryan-Nightwish:fix/workflow-agent-doc-snippets
Jun 8, 2026
Merged

[bugfix][docs] Fix workflow agent quickstart code snippet and comment#808
wenjin272 merged 2 commits into
apache:mainfrom
Ryan-Nightwish:fix/workflow-agent-doc-snippets

Conversation

@Ryan-Nightwish
Copy link
Copy Markdown
Contributor

@Ryan-Nightwish Ryan-Nightwish commented Jun 8, 2026

Linked issue: #803

Purpose of change

Two doc-quality fixes for docs/content/docs/get-started/quickstart/workflow_agent.md:

  1. Python process_input code snippet out of sync with source (line 134-135) — the doc showed input_event = InputEvent.from_event(event) followed by input: ProductReview = input_event.input, but the actual source (review_analysis_agent.py line 91) uses input = ProductReview.model_validate(InputEvent.from_event(event).input). Updated the doc to match the source.

Tests

  • Verified the updated code snippet matches review_analysis_agent.py line 91
  • Verified the updated comment matches the single-agent source comment
  • No code changes

API

No public API changes.

Documentation

  • doc-needed
  • doc-not-needed
  • doc-included

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Ryan-Nightwish Ryan-Nightwish changed the title [docs] Fix workflow agent quickstart code snippet and comment [bugfix][docs] Fix workflow agent quickstart code snippet and comment Jun 8, 2026
@github-actions github-actions Bot added doc-included Your PR already contains the necessary documentation updates. fixVersion/0.3.0 The feature or bug should be implemented/fixed in the 0.3.0 version. priority/major Default priority of the PR or issue. and removed doc-included Your PR already contains the necessary documentation updates. labels Jun 8, 2026
…nt example

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added doc-included Your PR already contains the necessary documentation updates. and removed doc-included Your PR already contains the necessary documentation updates. labels Jun 8, 2026
Copy link
Copy Markdown
Contributor

@wenjin272 wenjin272 left a comment

Choose a reason for hiding this comment

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

LGTM

@wenjin272 wenjin272 merged commit 388a89e into apache:main Jun 8, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-included Your PR already contains the necessary documentation updates. fixVersion/0.3.0 The feature or bug should be implemented/fixed in the 0.3.0 version. priority/major Default priority of the PR or issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants