docs: update Claude docs from PR review analysis#523
Merged
Conversation
…06-15) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
ninja-shreyash
approved these changes
Jun 15, 2026
swati354
approved these changes
Jun 15, 2026
|
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.



Summary
Weekly analysis of PR comments (2026-06-08 -> 2026-06-15).
Analyzed 19 PRs with resolved review threads. Found 6 actionable insights.
Changes
agent_docs/rules.md@linkin@paramis redundant — TypeDoc auto-links parameter typesSource: PR feat(agents): add AgentMemory service (memory timeline, calls timeline, top spaces) #483, PR feat(agents): Agents service foundation + getAll (1/5) [PLT-103787] #492 — reviewer noted
{@link TypeName}in@paramlines adds noise; TypeDoc links parameter types automatically. Explicit{@link}is only needed in@returns.Sibling methods sharing a configuration pattern (e.g.,
excludeFromPrefix) each need independent tests for that configSource: PR feat(agents): getErrors — paginated agent errors (2/5) [PLT-103787] #503 —
getIncidentswas missing the OData-prefix exclusion test thatgetAllhad. IfexcludeFromPrefixwere dropped from one method, no unit test would catch it unless each method's suite independently verifies the behavior.agent_docs/conventions.mdTime-range parameters must be
Dateobjects, not stringsSource: PR feat(agents): Agents service foundation + getAll (1/5) [PLT-103787] #492, PR feat(agents): add AgentMemory service (memory timeline, calls timeline, top spaces) #483 — multiple reviewers (deepeshrai-tech, ninja-shreyash) flagged
startTime/endTimeas strings; the SDK should acceptDateobjects and convert to the API format internally, matching the MaestrogetTopRunCount()precedent.Omitvs?optional for fields with server-side defaultsSource: PR feat(tasks): support assignment criteria for group task assignment #499 — reviewer (Sandeepan-Ghosh-0312) flagged
Omit<..., 'assignmentCriteria'>when the field has a server default (SingleUser). UsingOmitimplies the field causes errors if included;?optional is correct when the API simply defaults the value.Named wrapper types for pure array responses are unnecessary
Source: PR feat(agents): add AgentMemory service (memory timeline, calls timeline, top spaces) #483, PR feat(governance): add Governance getPolicyTraces service #464 — reviewer (ninja-shreyash) asked to use
T[]directly when the response is a plain collection with no pagination metadata. Creating a named type just to holditems: T[]adds indirection with no value.Header-only options must be destructured before calling
PaginationHelpers.getAll()Source: PR feat(data-fabric): add folder support to entity schema and attachment ops #490 —
folderKeyleaked into GET query params and POST body because it wasn't destructured out ofoptionsbeforePaginationHelpers.getAll(). The pattern:const { folderKey, ...pagedOptions } = options ?? {}, then passfolderKeyviacreateHeaders().agent_docs/architecture.mdSource: PR feat(agents): add AgentMemory service (memory timeline, calls timeline, top spaces) #483 — discussion resolved that
/agents/memoryconflicts with the core import pattern; the correct approach is a flat dash-separated name like@uipath/uipath-typescript/agent-memory.No changes
CLAUDE.md— no relevant insights foundAgents.md— no relevant insights foundPRs Analyzed
🤖 Generated with Claude Code