Skip to content

docs(SDK-971): tsdoc models and internal hooks#1996

Merged
mariechatfield merged 13 commits into
mainfrom
marie/SDK-971-audit-existing-docs
Jun 3, 2026
Merged

docs(SDK-971): tsdoc models and internal hooks#1996
mariechatfield merged 13 commits into
mainfrom
marie/SDK-971-audit-existing-docs

Conversation

@mariechatfield
Copy link
Copy Markdown
Contributor

@mariechatfield mariechatfield commented Jun 3, 2026

Summary

Phase 1 — Internal easy wins (all parallel)

Mark everything @internal. No reference docs needed.

Directory Violations Notes
src/contexts/ApiProvider/ 3 React Query + auth wiring
src/contexts/LocaleProvider/ 2 i18n context
src/contexts/LoadingIndicatorProvider/ 2 loading indicator context
src/components/Flow/ 3 flow orchestration base
src/components/Base/ 4 base component abstractions
src/models/ 6 internal data models
src/contexts/ObservabilityProvider/ 5 wraps partner ObservabilityHook; the hook interface itself is public and documented in Phase 3 (src/types/)
src/hooks/ 12 useClientPagination, useContainerBreakpoints, useDateRangeFilter, useDebounce, useForkRef, useOverflowDetection, usePagination

Total: 37 violations, all parallel.

Changes

Each commit represents running /tsdoc-directory <directory> and commit in claude, using the new agent skills. This represents the first round of backfilling docs according to the docs audit and plan in Notion.

Related

mariechatfield and others added 8 commits June 2, 2026 17:40
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Delete unused PayPeriod, Payroll, and PayrollTotals model classes (no
imports anywhere in the codebase).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
export { useObservability } from './useObservability'
export { normalizeToSDKError } from '@/types/sdkError'
export type { ObservabilityProviderProps } from './ObservabilityProvider'
export type { ObservabilityContextValue } from './ObservabilityContext'
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix an error in the API report by exporting the type that the component references

Comment thread src/models/PayPeriod.ts Outdated
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Completely unused models, delete them instead of documenting them

@mariechatfield mariechatfield marked this pull request as ready for review June 3, 2026 18:59
@mariechatfield mariechatfield requested a review from a team as a code owner June 3, 2026 18:59
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This diff is a bit messy because I reran the api-report:derive script on the merged commit. to keep the diffs clean I may need to switch that to run automatically on branches soon 🫠

Copy link
Copy Markdown
Contributor

@jeffredodd jeffredodd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mariechatfield mariechatfield merged commit 5515c32 into main Jun 3, 2026
31 checks passed
@mariechatfield mariechatfield deleted the marie/SDK-971-audit-existing-docs branch June 3, 2026 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants