Skip to content

docs: update Claude docs from PR review analysis#544

Merged
ninja-shreyash merged 2 commits into
mainfrom
claude-docs-update/2026-06-22
Jun 23, 2026
Merged

docs: update Claude docs from PR review analysis#544
ninja-shreyash merged 2 commits into
mainfrom
claude-docs-update/2026-06-22

Conversation

@claude

@claude claude Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

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 object not T 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. Use T extends object (matching transformRequest) and cast internally. Also calls out that redundant explicit as T casts are noise when the function return type is already T.
    Source: PR fix: rewrite SDK field names in OData filter/orderby/select/expand [PLT-102084] #536 — reviewer noted the transformOptions fix attempt with Record<string, unknown> was rejected by the compiler; author used T extends object instead.

  • Aggregation/summary method naming: getTop{Noun} not getTop{VerbingNoun}
    E.g., getTopConsumption, getTopErrorCount — not getTopConsumingAgents, 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/getTopErroredAgents to getTopConsumption/getTopErrorCount.

  • Never derive Raw* internal types from public response types
    E.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 RawSpanResponse derived from SpanResponse.

agent_docs/rules.md

  • @internal methods/services: skip docs/oauth-scopes.md and mkdocs.yml
    The 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 insights
  • Agents.md — no relevant insights
  • agent_docs/architecture.md — no relevant insights

PRs Analyzed

PR Title Comments
#536 fix: rewrite SDK field names in OData filter/orderby/select/expand 15 threads
#535 feat(agents): summary & distribution services (5/5) 23 threads
#542 Version bump to 1.4.2
#540 feat(document-understanding): expose DU framework types as nameable named exports 0 threads
#538 feat: Add UiPath Sites plugin 8 threads
#496 feat(samples): add datafabric-app sample 37 threads
#534 chore: bump version to 1.4.1
#531 fix(data-fabric): route expansionLevel to URL query string 4 threads
#526 feat: Adding sample coded action apps
#532 fix(auth): bootstrap token for host-embedded coded apps 3 threads
#527 feat(document-understanding): add DocumentUnderstanding service 20 threads
#525 feat(agents): timeline services — errors/consumption/latency (4/5) 6 threads
#504 feat(data-fabric): add folderKey support to entities.getAll and ChoiceSets 21 threads
#477 feat(coded-apps): inject all uipath.json keys as meta tags
#524 chore(ci): remove claude.yml workflow
#523 docs: update Claude docs from PR review analysis
#511 feat: add GA docs for coded action apps
#505 feat(agents): trace controller methods — timelines + span lookup 24 threads
#520 test(action-center): assign tasks to a configured group 2 threads

@claude claude Bot requested a review from a team June 22, 2026 10:54
@claude claude Bot added the claude-docs-update Automated Claude docs enhancement label Jun 22, 2026
@claude claude Bot requested a review from ninja-shreyash June 22, 2026 10:54
@claude

claude Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor Author

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

1 similar comment
@claude

claude Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor Author

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

@sonarqubecloud

Copy link
Copy Markdown

@ninja-shreyash ninja-shreyash merged commit 6cf0009 into main Jun 23, 2026
18 checks passed
@ninja-shreyash ninja-shreyash deleted the claude-docs-update/2026-06-22 branch June 23, 2026 05:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

claude-docs-update Automated Claude docs enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants