Skip to content

Commit ff426a6

Browse files
committed
feat: update docs
1 parent e3f3273 commit ff426a6

3 files changed

Lines changed: 10 additions & 5 deletions

File tree

packages/docs/pages/development/development-guide.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,10 @@ pnpm build:storybook
203203

204204
### Release Process
205205

206-
1. **Version Bump**: Update version in `package.json` for all affected packages
207-
2. **Build**: `pnpm build:all`
208-
3. **Test**: `pnpm test`
209-
4. **Publish**: Publish to npm
206+
1. **Version Bump**: `pnpm set-version <version>` (updates all packages, commits, and tags)
207+
2. **Push to master**: `git push origin master --tags`
208+
3. GitHub Actions (`release.yaml`) will automatically build and publish all packages to npm
209+
210+
> **Recommended:** Release via GitHub Actions rather than manually. The CI pipeline handles build order and dependency resolution correctly.
211+
>
212+
> If you must publish manually, always use `pnpm publish` (not `npm publish`). `pnpm publish` automatically converts `workspace:*` references to actual version numbers. `npm publish` will leave `workspace:*` as-is, causing installation failures for users.

packages/docs/pages/getting-started/_meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
"features": "Features",
44
"react": "React",
55
"vue": "Vue",
6+
"svelte": "Svelte",
67
"vanilla": "Vanilla JavaScript"
78
}

packages/docs/pages/getting-started/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ GridSheet provides Excel-like spreadsheet functionality across multiple framewor
88
|-----------|----------|----------|
99
| **[React](/getting-started/react)** | Full-featured with hooks, TypeScript, comprehensive events | React apps, TypeScript projects, complex state |
1010
| **[Vue](/getting-started/vue)** | Composition API, Options API, Vue 3 support | Vue applications, progressive enhancement |
11+
| **[Svelte](/getting-started/svelte)** | Svelte 5 runes, writable stores | Svelte applications, reactive UIs |
1112
| **[Vanilla JS](/getting-started/vanilla)** | Framework-agnostic, minimal bundle size | Vanilla JS, legacy apps, minimal dependencies |
1213

13-
**Note:** React and Vanilla JS versions support all GridSheet features. Vue versions have some limitations due to being wrapped implementations.
14+
**Note:** React and Vanilla JS versions support all GridSheet features. Vue and Svelte versions have some limitations due to being wrapped implementations.

0 commit comments

Comments
 (0)