Skip to content

docs: update Claude docs from PR review analysis#559

Open
claude[bot] wants to merge 1 commit into
mainfrom
claude-docs-update/2026-06-29
Open

docs: update Claude docs from PR review analysis#559
claude[bot] wants to merge 1 commit into
mainfrom
claude-docs-update/2026-06-29

Conversation

@claude

@claude claude Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Weekly analysis of PR comments (2026-06-22 -> 2026-06-29).
Analyzed 8 PRs with 77 review threads. Found 4 actionable insights.

Changes

agent_docs/conventions.md

agent_docs/rules.md

  • Never use unexplained abbreviations/acronyms in JSDoc — added to JSDoc quality rules. Spell out full forms; introduce abbreviated forms with the full name first.
    Source: PR feat(agents): summary & distribution services (5/5) [PLT-103787] #535 — reviewer flagged undocumented acronyms AGU and PLTU in JSDoc comments; author expanded them.

  • Never use @internal on individual fields of a public interface — added to JSDoc quality rules. TypeDoc omits the field from docs but TypeScript consumers still see it in IDE autocomplete. @internal belongs only on whole declarations.
    Source: PR feat: allow to emit end exchange event from client for stopping response #510 — reviewer noted that @internal endedAt on a field in the public Exchange interface misleads consumers who still get IDE completion for it.

No changes

  • CLAUDE.md — no relevant insights found
  • Agents.md — no relevant insights found
  • agent_docs/architecture.md — no relevant insights found

PRs Analyzed

PR Title Comments
#548 fix: rewrite SDK field names in OData options for remaining services 7
#508 feat: add client-side tool support 4
#510 feat: allow to emit end exchange event from client for stopping response 12
#487 feat(maestro): add getIncidentsTimeline to MaestroProcesses and Cases 8
#478 feat(insights): add getInstanceStats to MaestroProcesses and Cases 13
#536 fix: rewrite SDK field names in OData filter/orderby/select/expand 16
#535 feat(agents): summary & distribution services (5/5) 24
#545 chore: bump version to 1.5.0 0

…06-29)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot requested a review from a team June 29, 2026 10:34
@claude claude Bot added the claude-docs-update Automated Claude docs enhancement label Jun 29, 2026
@claude claude Bot requested a review from ninja-shreyash June 29, 2026 10:34
@claude

claude Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

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

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.

1 participant