-
Notifications
You must be signed in to change notification settings - Fork 59
docs: add "Adding a Framework Harness" guide and fix dangling workflow references - #426
Open
michaelxu2288 wants to merge 1 commit into
Open
docs: add "Adding a Framework Harness" guide and fix dangling workflow references #426michaelxu2288 wants to merge 1 commit into
michaelxu2288 wants to merge 1 commit into
Conversation
...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
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.
Uh oh!
There was an error while loading. Please reload this page.
What
getting_started/choose_your_agent_type.mdanddevelopment_guides/streaming_patterns.md(both from #337) point readers to anagentex-add-agent-frameworkworkflow that does not exist in this repo or in scale-agentex-python. This addsdevelopment_guides/adding_a_framework_harness.md: the files a new harness needs (tap +<Fw>Turn, exports, tests,agentex inittemplates andTemplateTyperegistration, 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 --strictwithdocs/requirements.txt: the new page renders and links resolve; the 15 strict-mode warnings are pre-existing (astate_management.mdlink, twomigration_guide.mdanchors, griffe signature warnings) and none involve the changed files.https://claude.ai/code/session_01HCVKnA7LeJZ44nxZz1uzF3
The documentation-only PR appears safe to merge, with its new links, anchors, and navigation entry resolving correctly.
Summary
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]Reviews (1) · Last reviewed commit: "docs: add 'Adding a Framework Harness' g..."