Skip to content

docs: update Claude docs from PR review analysis - #559

Merged
ninja-shreyash merged 2 commits into
mainfrom
claude-docs-update/2026-06-29
Jul 8, 2026
Merged

docs: update Claude docs from PR review analysis#559
ninja-shreyash merged 2 commits 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 to 2026-07-06).
Analyzed 16 PRs with resolved review threads. Found 6 actionable insights across 2 runs.

Changes

agent_docs/conventions.md

  • Keep inline code comments concise — added rule: say what is non-obvious in a single phrase; avoid restating what the code expresses.
  • Timestamp field naming — all timestamp fields must use *Time suffix; *At suffixes break consistency across the SDK.
  • Multi-domain responses in transform pipeline — when getById returns fields from multiple entity domains, merge multiple field maps: transformData(data, { ...PrimaryEntityMap, ...SecondaryEntityMap }).

agent_docs/rules.md

  • NEVER use unexplained abbreviations/acronyms in JSDoc — spell out the full form or introduce with the expanded form first.
  • NEVER use @internal on individual fields of a public interface — TypeDoc hides them from docs but IDE autocomplete still shows them; use internal type files instead.
  • Propagate @experimental alongside @internal — extended the propagation rule to cover @experimental tags, which must appear on every public layer (service class, wrapper class) when the service model carries it.
  • describe.skip equivalence for vitest config exclusions — excluding integration test files via env vars in vitest.integration.config.ts is functionally equivalent to describe.skip and equally prohibited; use beforeAll + throw inside the test file instead.
  • Snapshot+restore pattern for mutating integration tests — when an operation has wide-reaching side effects (e.g., mark-all-read), read current state before the test and restore it in cleanup to avoid corrupting subsequent tests.

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
#579 docs(governance): mark governance service and methods as experimental 2 threads
#495 feat(samples): add document-validation-app sample 13 threads
#541 docs: sample GitHub Action for coded app CI/CD 20 threads
#552 ci: add weekly coverage run against main branch 2 threads
#514 feat(notifications): delete flows (PR 3/7) 3 threads
#572 fix(data-fabric): stop requiring referenceEntityId/referenceFieldId for FILE fields 1 thread
#573 chore: bump version to 1.5.1 0 threads
#513 feat(notifications): mark-read flows (PR 2/7) 6 threads
#560 feat(traces): add agentic governance traces and summary methods many threads
#571 test(data-fabric): make ApiClient mocks constructable for vitest 4 0 threads
#570 test(notifications): make ApiClient mock constructable for vitest 4 0 threads
#473 feat: add Data Fabric roles and directory services many threads
#550 test+deps: bump vitest to 4.x 1 thread
#553 feat(maestro): add retry to process instances 6 threads
#512 feat(notifications): foundation + getAll (PR 1/7) many threads
#548 fix: rewrite SDK field names in OData options for remaining services many threads

@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.

@claude

claude Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

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

github-actions Bot and others added 2 commits July 8, 2026 12:50
…06-29)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…07-06)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ninja-shreyash
ninja-shreyash force-pushed the claude-docs-update/2026-06-29 branch from 263ecea to e7d2a9e Compare July 8, 2026 07:20
@claude

claude Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

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

@sonarqubecloud

sonarqubecloud Bot commented Jul 8, 2026

Copy link
Copy Markdown

@ninja-shreyash
ninja-shreyash merged commit b330ae1 into main Jul 8, 2026
14 checks passed
@ninja-shreyash
ninja-shreyash deleted the claude-docs-update/2026-06-29 branch July 8, 2026 07:27
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.

3 participants