Skip to content

Navigation Menu

Sign in
Sign up

docs: add "Adding a Framework Harness" guide and fix dangling workflow references - #426

Open
michaelxu2288 wants to merge 1 commit into
scaleapi:main from
michaelxu2288:docs/framework-harness-guide
Open

docs: add "Adding a Framework Harness" guide and fix dangling workflow references #426
michaelxu2288 wants to merge 1 commit into
scaleapi:main from
michaelxu2288:docs/framework-harness-guide

Conversation

@michaelxu2288

@michaelxu2288 michaelxu2288 commented Sep 10, 2026
edited by greptile-apps Bot
Loading

Copy link
Copy Markdown

What

getting_started/choose_your_agent_type.md and development_guides/streaming_patterns.md (both from #337) point readers to an agentex-add-agent-framework workflow that does not exist in this repo or in scale-agentex-python. This adds development_guides/adding_a_framework_harness.md: the files a new harness needs (tap + <Fw>Turn, exports, tests, agentex init templates and TemplateType registration, tutorials, docs page + nav), modelled on the Claude Code harness, and repoints both references. Adds the page to the nav under Framework Agents.

Test

mkdocs build --strict with docs/requirements.txt: the new page renders and links resolve; the 15 strict-mode warnings are pre-existing (a state_management.md link, two migration_guide.md anchors, griffe signature warnings) and none involve the changed files.

https://claude.ai/code/session_01HCVKnA7LeJZ44nxZz1uzF3

RetriggerConfidence Score: 5/5

The documentation-only PR appears safe to merge, with its new links, anchors, and navigation entry resolving correctly.

Summary

  • Documents the tap, turn, tests, templates, tutorials, exports, and documentation expected for a new harness.
  • Links the existing framework-selection and streaming guides to the new page.
  • Adds the page under Development Guides → Framework Agents.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart LR
 A[Framework native event stream] --> B[Framework tap]
 B --> C[Canonical StreamTaskMessage events]
 C --> D[Framework HarnessTurn]
 D --> E[UnifiedEmitter or auto_send_turn]
 E --> F[Streaming delivery and derived spans]
 D --> G[Normalized usage]
Loading

Reviews (1) · Last reviewed commit: "docs: add 'Adding a Framework Harness' g..."

greptile-apps[bot] reacted with thumbs up emoji
...w references
choose_your_agent_type.md and streaming_patterns.md pointed to an
agentex-add-agent-framework workflow that does not exist in either repository
(introduced in scaleapi#337). Replace both references with a guide that lists the
files a new harness needs (tap, turn, exports, tests, init templates,
tutorials, docs), mirroring the Claude Code harness, and add it to the nav.
Claude-Session: https://claude.ai/code/session_01HCVKnA7LeJZ44nxZz1uzF3 
michaelxu2288 requested a review from a team as a code owner September 10, 2026 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

AltStyle によって変換されたページ (->オリジナル) /