fixup(langgraph): canonical regenerate JSDoc to unblock api-docs gate#208
Merged
Conversation
PR #207 merged with admin override while CI's stale-api-docs gate was red — the gate is now red on main. The shorter JSDoc on LangGraphAgent.regenerate (added in #207) caused TypeDoc to emit a description that diverges from the committed agent/api/api-docs.json. Match the canonical text from libs/chat/src/lib/agent/agent.ts:38-46 so the regenerated docs are byte-identical to what's already on main. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
2 tasks
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.
Summary
PR #207 was merged via admin override while the stale-api-docs CI gate was red. The gate is now failing on main.
The shorter JSDoc on
LangGraphAgent.regenerate(added in #207) causes TypeDoc to emit a description that diverges from the committedapps/website/content/docs/agent/api/api-docs.json. CI'sgit diff --exit-codecheck on the regenerated api-docs blocks any subsequent green build until this is fixed.This PR matches the canonical JSDoc text from
libs/chat/src/lib/agent/agent.ts:38-46(where theregeneratemethod is originally declared on the parentAgentinterface) so the regenerated docs are byte-identical to what's already on main.Why not regenerate and commit api-docs instead: the implementation's intent is to inherit the parent contract's docstring, not to introduce a new (less-detailed) one. Matching JSDoc keeps a single source of truth.
Test plan
nx run langgraph:test(29 specs pass)nx run langgraph:lint(0 errors)🤖 Generated with Claude Code