Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

Update fundamentals package docs to current APIs#6

Merged
vitbokisch merged 2 commits into
mainfrom
docs/update-fundamentals-api
Mar 17, 2026
Merged

Update fundamentals package docs to current APIs#6
vitbokisch merged 2 commits into
mainfrom
docs/update-fundamentals-api

Conversation

@vitbokisch

Copy link
Copy Markdown
Contributor

Summary

Update documentation for all fundamentals ecosystem packages to reflect the current API after the store redesign, type safety improvements, and validation duck-type changes.

Store — Major rewrite

  • Replace all $-prefixed API ($patch, $subscribe, $onAction, $reset, $dispose, $state, $id) with StoreApi<T> pattern
  • All examples updated to const { store, patch, subscribe } = useCounter()

Form

  • Add Accessor<T> = Signal<T> | Computed<T> type documentation
  • isValid/isDirty updated to Accessor<boolean>
  • register() now documents { type: 'number' } option

Validation

  • ArkType uses ArkTypeCallable (any callable, no allows method required)
  • Zod duck type notes PropertyKey[] paths for v4 compatibility
  • Valibot notes Function type for GenericSafeParseFn

Storybook — Major expansion (137 → 527 lines)

  • Meta/StoryObj options, decorators, reactive stories
  • Interaction testing with play functions
  • renderToCanvas lifecycle, full example

🤖 Generated with Claude Code

vitbokisch and others added 2 commits March 17, 2026 16:43
Store:
- Replace all $-prefixed API with StoreApi<T> pattern
- Update examples to destructured { store, patch, subscribe }
- Update plugin type, API reference, testing patterns

Form:
- Add Accessor<T> = Signal<T> | Computed<T> type
- Update isValid/isDirty to Accessor<boolean>
- Add register type:'number' docs

Validation:
- Update ArkType to ArkTypeCallable (drop allows)
- Note PropertyKey[] paths for Zod v4 compat
- Note Function type for Valibot GenericSafeParseFn

Storybook:
- Expand from 137 to 527 lines
- Add Meta/StoryObj options, decorators, reactive stories,
  interaction testing, renderToCanvas lifecycle, full example

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Auto-formatted api-card.tsx, package-badge.tsx, prop-table.tsx.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vitbokisch vitbokisch merged commit 62c1803 into main Mar 17, 2026
4 of 5 checks passed
@vitbokisch vitbokisch deleted the docs/update-fundamentals-api branch March 17, 2026 15:52
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant