Skip to content

Commit 00b6799

Browse files
committed
Merge branch 'main' into feat-openclaw
2 parents 918ac3d + 917cb38 commit 00b6799

1,566 files changed

Lines changed: 146860 additions & 139019 deletions

File tree

Some content is hidden

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

.github/workflows/auto-assign-issue.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616

1717
- name: Assign the issue
1818
run: |
19-
export LETASE_MILESTONES=$(curl 'https://api.github.com/repos/$OWNER/$PEPO/milestones' | jq -r 'last(.[]).title')
19+
export LETASE_MILESTONES=$(curl 'https://api.github.com/repos/$OWNER/$REPO/milestones' | jq -r 'last(.[]).title')
2020
gh issue edit ${{ github.event.issue.number }} --add-assignee "${{ github.event.comment.user.login }}"
2121
gh issue edit ${{ github.event.issue.number }} --add-label "accepted"
2222
gh issue comment $ISSUE --body "@${{ github.event.comment.user.login }} Glad to see you accepted this issue🤲, this issue has been assigned to you. I set the milestones for this issue to [$LETASE_MILESTONES](https://github.com/$OWNER/$PEPO/milestones), We are looking forward to your PR!"

.github/workflows/build-ci.yaml

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,34 @@ name: Documentation Deployment
33
on:
44
push:
55
branches:
6-
- main # Trigger the action on push events to the main branch
7-
6+
- main
87

98
jobs:
109
build_and_deploy:
1110
runs-on: ubuntu-latest
1211

1312
steps:
1413
- name: Checkout repository
15-
uses: actions/checkout@v2
14+
uses: actions/checkout@v4
1615

1716
- name: Setup Node.js
18-
uses: actions/setup-node@v2
17+
uses: actions/setup-node@v4
1918
with:
20-
node-version: '18'
19+
node-version: '20'
20+
21+
- name: Install pnpm
22+
uses: pnpm/action-setup@v4
23+
with:
24+
version: 9
2125

2226
- name: Install dependencies
23-
run: npm install
27+
run: pnpm install --frozen-lockfile
2428

2529
- name: Build documentation
26-
run: npm run build
30+
run: pnpm build
2731

2832
- name: Deploy to GitHub Pages
29-
uses: peaceiris/actions-gh-pages@v3
33+
uses: peaceiris/actions-gh-pages@v4
3034
with:
3135
github_token: ${{ secrets.GITHUB_TOKEN }}
3236
publish_dir: ./build

.github/workflows/main-ci.yaml

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Pull Request Checks
33
on:
44
pull_request:
55
branches:
6-
- main # Trigger the action on pull requests to the main branch
6+
- main
77

88
jobs:
99
test:
@@ -16,18 +16,23 @@ jobs:
1616
- name: Setup Node.js
1717
uses: actions/setup-node@v4
1818
with:
19-
node-version: 'latest'
19+
node-version: '20'
20+
21+
- name: Install pnpm
22+
uses: pnpm/action-setup@v4
23+
with:
24+
version: 9
2025

2126
- name: Install dependencies
22-
run: npm install
27+
run: pnpm install --frozen-lockfile
2328

2429
- name: Build documentation
25-
run: npm run build
30+
run: pnpm build
2631

2732
- name: Lint check
28-
run: npm run lint
33+
run: pnpm lint
2934
continue-on-error: true
3035

3136
- name: Type checking
32-
run: npm run typecheck
37+
run: pnpm typecheck
3338
continue-on-error: true

.github/workflows/release.yml

Lines changed: 0 additions & 64 deletions
This file was deleted.

AGENTS.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# OpenIM Docs - Codex Agent Instructions
2+
3+
## Project Overview
4+
5+
This is the OpenIM documentation site built with Docusaurus. It supports two locales:
6+
- **zh-Hans** (Chinese, default): Source files in `docs/`
7+
- **en** (English): Translated files in `i18n/en/`
8+
9+
## Translation Task
10+
11+
When asked to translate documentation, follow the rules below.
12+
13+
### Path Mapping
14+
15+
| Source (Chinese) | Target (English) |
16+
|-----------------|------------------|
17+
| `docs/sdks/` | `i18n/en/docusaurus-plugin-content-docs-sdks/current/` |
18+
| `docs/guides/` | `i18n/en/docusaurus-plugin-content-docs-guides/current/` |
19+
| `docs/restapi/` | `i18n/en/docusaurus-plugin-content-docs-restapi/current/` |
20+
| `docs/blog/` | `i18n/en/docusaurus-plugin-content-docs-blog/current/` |
21+
22+
### Translation Rules
23+
24+
1. **Keep unchanged**:
25+
- All code blocks (` ``` `) content
26+
- Frontmatter keys (only translate Chinese values like `title`, `description`)
27+
- JSX/MDX component tags (`<Tabs>`, `<TabItem>`, etc.)
28+
- Markdown link paths and URLs
29+
- Variable names, function names, class names
30+
- Import statements
31+
32+
2. **Translate**:
33+
- All Chinese text content to natural English
34+
- Table headers and cell content (Chinese → English)
35+
- Section headings (e.g., `## 功能介绍``## Description`)
36+
- Inline comments in code examples (Chinese → English)
37+
38+
3. **Common translations** (keep consistent across all files):
39+
- 功能介绍 → Description
40+
- 返回原型 → Return Prototype
41+
- 返回结果 → Return Results
42+
- 调用示例 → Call Example
43+
- 名称 → Name
44+
- 类型 → Type
45+
- 描述 → Description
46+
47+
### Sidebar Labels
48+
49+
Sidebar category labels for each docs plugin are translated in **two places**:
50+
51+
1. **`_category_.json`** files in the corresponding `i18n/en/` directory
52+
2. **`current.json`** files at `i18n/en/docusaurus-plugin-content-docs-*/current.json`
53+
54+
For `current.json`:
55+
- The **key** stays the same (may contain Chinese category name as identifier)
56+
- Only the **`message`** field should be translated to English
57+
- The **`description`** field should also be updated to reflect the English label
58+
59+
Example:
60+
```json
61+
{
62+
"sidebar.tutorialSidebar.category.用户管理": {
63+
"message": "User Management",
64+
"description": "The label for category 'User Management' in sidebar 'tutorialSidebar'"
65+
}
66+
}
67+
```
68+
69+
### New Category Handling
70+
71+
If a new `_category_.json` is added in the source `docs/` directory:
72+
1. Create the corresponding `_category_.json` in `i18n/en/` with translated `label`
73+
2. Run `npx docusaurus write-translations --locale en` to regenerate `current.json`
74+
3. Translate any new Chinese entries in `current.json`
75+
76+
## Verification
77+
78+
After translating, verify:
79+
1. No Chinese characters remain in translated `message` values
80+
2. Build succeeds: `pnpm build`

amplify.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ frontend:
33
phases:
44
preBuild:
55
commands:
6-
- nvm install 15 && npm ci
6+
- nvm install 20 && npm ci
77
build:
88
commands:
99
- npm run build
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"key": "architectural-browser",
3+
"label": "Browser"
4+
}

docs/blog/client/architectural/Browser/wasm-client-sdk-introduction.mdx renamed to docs/blog/client/architectural/Browser/wasm-client-sdk-introduction.md

File renamed without changes.

0 commit comments

Comments
 (0)