docs: update Claude docs from PR review analysis#544
Merged
Conversation
Contributor
Author
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
1 similar comment
Contributor
Author
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
|
ninja-shreyash
approved these changes
Jun 22, 2026
Sarath1018
approved these changes
Jun 23, 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-15 → 2026-06-22).
Analyzed 19 PRs with review threads. Found 4 actionable insights.
Changes
agent_docs/conventions.md
Generic constraints:
T extends objectnotT extends Record<string, unknown>TypeScript interfaces lack an index signature, so they don't structurally satisfy
Record<string, unknown>— this causes TS2345 at call sites. UseT extends object(matchingtransformRequest) and cast internally. Also calls out that redundant explicitas Tcasts are noise when the function return type is alreadyT.Source: PR fix: rewrite SDK field names in OData filter/orderby/select/expand [PLT-102084] #536 — reviewer noted the
transformOptionsfix attempt withRecord<string, unknown>was rejected by the compiler; author usedT extends objectinstead.Aggregation/summary method naming:
getTop{Noun}notgetTop{VerbingNoun}E.g.,
getTopConsumption,getTopErrorCount— notgetTopConsumingAgents,getTopErroredAgents. The noun names the metric ranked, not the entity type.Source: PR feat(agents): summary & distribution services (5/5) [PLT-103787] #535 — reviewer renamed methods from
getTopConsumingAgents/getTopErroredAgentstogetTopConsumption/getTopErrorCount.Never derive
Raw*internal types from public response typesE.g.,
type RawSpanResponse = Omit<SpanResponse, ...>is wrong — if the public type changes, the raw type breaks silently. Raw types describe the API wire format independently.Source: PR feat(agents): trace controller methods — timelines + span lookup [PLT-103787] #505 — reviewer flagged
RawSpanResponsederived fromSpanResponse.agent_docs/rules.md
@internalmethods/services: skipdocs/oauth-scopes.mdandmkdocs.ymlThe existing rule says "NEVER skip" oauth-scopes.md updates, but reviewers confirmed internal-only methods/services have no public API surface and should not get OAuth scope entries or nav entries. Added as an explicit exception to both the rule and the post-implementation checklist.
Source: PR feat(document-understanding): add DocumentUnderstanding service #527 — reviewers: "We don't document for internal methods"; nav/scope entries for an
@internal-only DU service were determined unnecessary.No changes
CLAUDE.md— no relevant insightsAgents.md— no relevant insightsagent_docs/architecture.md— no relevant insightsPRs Analyzed