Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mobily committed Apr 8, 2024
1 parent c2e0b28 commit e034185
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 2 deletions.
Binary file modified docs/bun.lockb
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
},
"dependencies": {
"@grapp/nextra-theme": "^0.3.8",
"@grapp/stacks": "link:@grapp/stacks",
"@grapp/stacks": "3.0.0",
"react-element-to-jsx-string": "^15.0.0",
"react-native-web": "^0.19.10"
}
Expand Down
8 changes: 8 additions & 0 deletions docs/pages/docs/migration-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@

import { Callout } from "nextra/components";

## Migration Guide

The migration process should be hassle-free for users upgrading from Stacks v2 to v3. However, you should be aware of some notable changes.

<Callout type="warning" emoji="⚠️">
`Stacks` is now published in the `@grapp` scope. So, you need to fix the imports first. Don't worry, it's a quick fix!
~`@mobily/stacks`~`@grapp/stacks`
</Callout>

### General

The `Stacks` library has been completely rewritten in TypeScript, so it no longer supports ReScript.
Expand Down
3 changes: 2 additions & 1 deletion docs/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"next-env.d.ts",
"./docs/**/*.ts",
"./docs/**/*.tsx",
"./examples/**/*.tsx"
"./examples/**/*.tsx",
"./unistyles.ts"
],
"compilerOptions": {
"incremental": true
Expand Down
4 changes: 4 additions & 0 deletions docs/unistyles.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ declare module 'react-native-unistyles' {
export interface UnistylesThemes extends Themes {}
}

declare module '@grapp/stacks' {
export interface StacksBreakpoints extends Breakpoints {}
}

UnistylesRegistry.addBreakpoints(breakpoints).addThemes({
light: theme,
});

0 comments on commit e034185

Please sign in to comment.