Skip to content

docs: document the 1.0 API - #9

Merged
devCrossNet merged 1 commit into
mainfrom
docs/v1
Oct 8, 2026
Merged

devCrossNet merged 1 commit into
mainfrom
docs/v1

Conversation

@devCrossNet

Copy link
Copy Markdown
Owner

What is accomplished by your PR?

  • README for the 1.0 API: getting started, component types, branching and conditions, variants, the path, validation, back/progress, navigation, restore, framework integration (React and Vue), TypeScript, validateDefinition(), API reference
  • Migration table from 0.x
  • All example READMEs updated, READMEs for the new examples

Is there something controversial in your PR?

Stacked on #8 (build/dual-esm-cjs).

Checklist

  • Run unit tests to ensure all existing tests are still passing
  • Add new passing unit tests to cover the code introduced by your PR (docs only)
  • Change documentation for the code introduced by your PR

🤖 Generated with Claude Code

Base automatically changed from build/dual-esm-cjs to main October 8, 2026 18:53
- rewrite the readme for the new API: getting started, branching, conditions,
  variants, path, validation, navigation, framework integration, typescript
- add a migration table from 0.x
- update all example readmes and add the new ones

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@devCrossNet
devCrossNet merged commit 560ba47 into main Oct 8, 2026
2 checks passed
@devCrossNet
devCrossNet deleted the docs/v1 branch October 8, 2026 18:56
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.

1 participant