Skip to content

Commit 622257a

Browse files
authored
chore: enable docs versioning (#250)
1 parent 565911e commit 622257a

File tree

121 files changed

+14493
-17
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+14493
-17
lines changed

docusaurus.config.js

+9
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ const config = {
3434
sidebarPath: require.resolve('./sidebars.js'),
3535
path: 'docs',
3636
editUrl: 'https://github.com/zenstackhq/zenstack-docs/edit/main',
37+
versions: {
38+
current: {
39+
label: '2.0 🚧',
40+
},
41+
},
3742
},
3843
blog: {
3944
showReadingTime: true,
@@ -96,6 +101,10 @@ const config = {
96101
label: 'Discord',
97102
position: 'right',
98103
},
104+
{
105+
type: 'docsVersionDropdown',
106+
position: 'right',
107+
},
99108
{
100109
type: 'html',
101110
position: 'left',

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
"@docusaurus/types": "^3.1.1",
3838
"@tailwindcss/typography": "^0.5.9",
3939
"@tsconfig/docusaurus": "^2.0.2",
40+
"@types/node": "^20.11.17",
4041
"@types/react": "^18.0.26",
4142
"typescript": "^5.3.3"
4243
},

pnpm-lock.yaml

+25-17
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- Email/password based signin/signup.
2+
- `Space` for multi-tenancy management. Users can join multiple spaces, and a space can have many users.
3+
- Users can be of "USER" or "ADMIN" role in a space. Space admins can manage space members.
4+
- Users can manage Todo lists and items in spaces they belong to.
5+
- Public Todo lists are accessible to all space members. Private lists are only accessible to the owner and space admins.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import ZenStackInit from './_zenstack-init.md'
2+
3+
:::tip
4+
5+
<ZenStackInit />
6+
7+
:::
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
The "init" command does the following things for you:
2+
3+
1. Install Prisma if it's not already installed.
4+
2. Install the `zenstack` CLI package as a dev dependency.
5+
3. Install the `@zenstackhq/runtime` package - used for enhancing `PrismaClient` at the runtime.
6+
4. Copy the `prisma/schema.prisma` file to `schema.zmodel` if it exists; otherwise, create a new template `schema.zmodel` file.
7+
8+
You can always manually complete the steps above if you have a special project setup that the "init" command doesn't work with.
9+
10+
After the initialization, please remember that you should edit the `schema.zmodel` moving forward. The `prisma/schema.prisma` file will be automatically regenerated when you run `zenstack generate`.
Loading
Loading
Loading

0 commit comments

Comments
 (0)