ci(dx): require @example on the authoring surface#717
Merged
Conversation
…gglers Tightens the DX-coverage guard: functions developers call to wire/use the framework (provide*/inject*/mock*, the client-tool builders, and the view- registry helpers views/withViews/withoutViews/overrideViews/toRenderRegistry) must now carry an @example, not just a summary. Added @example to the authoring-surface functions that lacked one: render views/withViews/withoutViews/overrideViews/toRenderRegistry + injectRenderHost, ag-ui + langgraph provideFakeAgent, and langgraph mockLangGraphAgent. Guard: "all 65 public functions have a summary; all 29 authoring-surface functions have an @example." render/ag-ui/langgraph build green; api-docs regenerated. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
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
1 participant
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.
What
Tightens the DX-coverage guard (#715) so that authoring-surface functions — the ones developers call to wire/use the framework — must carry an
@example, not just a summary.Authoring surface =
provide*/inject*/mock*+ the client-tool builders (tools/action/view/ask) + the view-registry helpers (views/withViews/withoutViews/overrideViews/toRenderRegistry) +defineAngularRegistry/createAgentRef/signalStateStore. (Plumbing/utility functions still only need a summary — examples there would be noise.)Documented the stragglers
Added
@exampleto the authoring-surface functions that lacked one: renderviews/withViews/withoutViews/overrideViews/toRenderRegistry+injectRenderHost, ag-ui + langgraphprovideFakeAgent, langgraphmockLangGraphAgent.Result
render/ag-ui/langgraphbuild green; api-docs regenerated/committed.🤖 Generated with Claude Code