Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions apps/website/AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AGENTS.md

This file stores website-specific working notes for Codex.

## Website Dev Server Notes

- If the website page still shows old code after local changes, first suspect a stale `rspress dev` process instead of assuming the latest patch failed.
- The website preview stack uses `@rspress/plugin-preview`, which also starts a preview service and occupies port `7890` by default.
- If port `7890` is already occupied by an older website dev process, a newly started website dev server may fail to reflect the latest page output correctly.
- In that situation, stop the old website `rspress dev` process, then restart the website dev server before continuing debugging.
- After restarting the website dev server, remind the user to do a hard refresh with `Ctrl+Shift+R`.
- When a page still looks stale, prefer verifying the actual running dev server and occupied ports before changing product code again.
6 changes: 3 additions & 3 deletions apps/website/docs/zh-CN/vbi/api/dimensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ toJSON(): VBIDimension[]
**定义**:

```typescript
observe(callback: ObserveCallback): () => void
observe(callback: ObserveDeepCallback): () => void
```

**返回**: `() => void`
Expand All @@ -135,7 +135,7 @@ observe(callback: ObserveCallback): () => void

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `callback` | ObserveCallback | - 回调函数 |
| `callback` | ObserveDeepCallback | - 回调函数 |

### static isDimensionNode

Expand Down Expand Up @@ -167,4 +167,4 @@ static isDimensionGroup(node: VBIDimensionTree[0]): node is VBIDimensionGroup

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `node` | VBIDimensionTree[0] | - |
| `node` | VBIDimensionTree[0] | - |
6 changes: 3 additions & 3 deletions apps/website/docs/zh-CN/vbi/api/having-filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ toJSON(): VBIHavingGroup
**定义**:

```typescript
observe(callback: ObserveCallback): () => void
observe(callback: ObserveDeepCallback): () => void
```

**返回**: `() => void`
Expand All @@ -181,7 +181,7 @@ observe(callback: ObserveCallback): () => void

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `callback` | ObserveCallback | - 回调函数 |
| `callback` | ObserveDeepCallback | - 回调函数 |

### static isGroup

Expand Down Expand Up @@ -217,4 +217,4 @@ static isNode(yMap: Y.Map<any>): boolean

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `yMap` | Y.Map<any> | - |
| `yMap` | Y.Map<any> | - |
6 changes: 3 additions & 3 deletions apps/website/docs/zh-CN/vbi/api/measures.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ toJSON(): VBIMeasure[]
**定义**:

```typescript
observe(callback: ObserveCallback): () => void
observe(callback: ObserveDeepCallback): () => void
```

**返回**: `() => void`
Expand All @@ -135,7 +135,7 @@ observe(callback: ObserveCallback): () => void

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `callback` | ObserveCallback | - 回调函数 |
| `callback` | ObserveDeepCallback | - 回调函数 |

### static isMeasureNode

Expand Down Expand Up @@ -167,4 +167,4 @@ static isMeasureGroup(node: VBIMeasureTree[0]): node is VBIMeasureGroup

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `node` | VBIMeasureTree[0] | - |
| `node` | VBIMeasureTree[0] | - |
6 changes: 3 additions & 3 deletions apps/website/docs/zh-CN/vbi/api/where-filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ toJSON(): VBIWhereGroup
**定义**:

```typescript
observe(callback: ObserveCallback): () => void
observe(callback: ObserveDeepCallback): () => void
```

**返回**: `() => void`
Expand All @@ -181,7 +181,7 @@ observe(callback: ObserveCallback): () => void

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `callback` | ObserveCallback | - 回调函数 |
| `callback` | ObserveDeepCallback | - 回调函数 |

### static isGroup

Expand Down Expand Up @@ -217,4 +217,4 @@ static isNode(yMap: Y.Map<any>): boolean

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `yMap` | Y.Map<any> | - |
| `yMap` | Y.Map<any> | - |
3 changes: 2 additions & 1 deletion apps/website/docs/zh-CN/vbi/practices/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
{ "type": "file", "name": "standard", "label": "标准" },
{ "type": "file", "name": "minimalist", "label": "极简" },
{ "type": "file", "name": "streamlined", "label": "精简" },
{ "type": "file", "name": "professional", "label": "专业" }
{ "type": "file", "name": "professional", "label": "专业" },
{ "type": "file", "name": "vbi-react-starter", "label": "vbi-react Starter" }
]
7 changes: 7 additions & 0 deletions apps/website/docs/zh-CN/vbi/practices/vbi-react-starter.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# vbi-react Starter

import { APP } from 'vbi-react-starter'

<div style={{ width: '100%', height: '760px' }}>
<APP />
</div>
1 change: 1 addition & 0 deletions apps/website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"minimalist": "workspace:*",
"professional": "workspace:*",
"streamlined": "workspace:*",
"vbi-react-starter": "workspace:*",
"yjs": "13.6.28",
"zustand": "5.0.6"
},
Expand Down
3 changes: 3 additions & 0 deletions apps/website/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@
},
{
"path": "../../practices/professional"
},
{
"path": "../../practices/vbi-react-starter"
}
],
"include": ["docs", "components", "theme", "rspress.config.ts"],
Expand Down
Loading
Loading