Skip to content

fix: replace playground Vite template README with playground guide#75

Merged
Jaganath-MSJ merged 2 commits into
betafrom
dev
May 25, 2026
Merged

fix: replace playground Vite template README with playground guide#75
Jaganath-MSJ merged 2 commits into
betafrom
dev

Conversation

@Jaganath-MSJ

Copy link
Copy Markdown
Owner

Description

Promotes the playground README rewrite from dev to beta. Swaps the
boilerplate "React + TypeScript + Vite" template README for documentation
specific to the calendar-simple playground. Docs-only — no library or
playground source code is touched.

  • Explain the file:.. dependency on the library's dist/ build, so the
    playground imports the package exactly like an external consumer
  • Document the build-library-first setup step (dist/ is git-ignored)
  • Add a scripts table, a source-file tour, and usage tips

Fixes # (n/a)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactor / chore (no functional change)

Pull Request Checklist

  • My commit messages follow the Conventional Commits spec
  • I have updated the documentation where relevant
  • I have added or updated tests that cover my change (n/a — docs only)
  • I have added or updated a Storybook story (n/a — docs only)

How Has This Been Tested?

Documentation-only change; no automated tests required.

  • Reviewed rendered Markdown in the playground README
  • Confirmed only playground/README.md changed (git diff --stat origin/beta..dev)

Screenshots / Recordings

N/A — no UI changes.

Swap the boilerplate Vite + TypeScript README for documentation
specific to the calendar-simple playground.

- Explain the file:.. dependency on the library's dist/ build
- Document the build-library-first setup step (dist/ is git-ignored)
- Add scripts table, source-file tour, and usage tips
@Jaganath-MSJ Jaganath-MSJ merged commit 00ec25e into beta May 25, 2026
5 checks passed
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 2.0.0-beta.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant