Skip to content

Commit 068c488

Browse files
committed
docs: comprehensive documentation overhaul
- Restructure documentation directory to match sidebar categories - Rewrite all 22 API docs with MCP-verified endpoints - Fix Docker/container hallucinations across all docs (CoreClaw uses lightweight script runtime) - Remove XLSX export format hallucinations (only JSON/CSV supported) - Fix revenue share wording: fixed 10% (not up to 10%) - Add Marketplace API endpoints (search + details) - Delete api/basic directory (EN + CN) - Add output_schema.json documentation (new Output Schema page) - Add Pricing Rules page for user guide - Fix b field requirement in input-schema (must be array type) - Localize all zh-cn page titles and descriptions - Remove duplicate Next Steps navigation sections - Fix dead links (find-a-worker, publishing/ path changes) - Rename publishing/ to publishing-and-monetization/ to match sidebar - Optimize repository example links to anchor text format - Update project structures to include output_schema.json - Build verified: 101 pages, 0 errors
1 parent b8f0ff6 commit 068c488

188 files changed

Lines changed: 8606 additions & 12975 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.

astro.config.mjs

Lines changed: 290 additions & 319 deletions
Large diffs are not rendered by default.

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@
2424
},
2525
"devDependencies": {
2626
"@eslint/js": "^9.39.4",
27+
"@playwright/test": "^1.59.1",
2728
"eslint": "^9.39.4",
2829
"globals": "^17.4.0",
30+
"playwright": "^1.59.1",
2931
"prettier": "3.8.1"
3032
}
3133
}

pnpm-lock.yaml

Lines changed: 41 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/components/Banner.astro

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ const categoryConfig: Record<
3333
subCategories?: Record<string, { label: string; labelZh: string; hasIndex?: boolean }>
3434
}
3535
> = {
36-
'getting-started': {
37-
label: 'Getting Started',
38-
labelZh: '快速开始',
36+
'home': {
37+
label: 'Home',
38+
labelZh: '首页',
3939
hasIndex: true,
4040
},
4141
'user-guide': {

src/content/docs/about-coreclaw.mdx

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

src/content/docs/api/account/info.md

Lines changed: 12 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,9 @@ sidebar:
55
order: 10
66
---
77

8-
**Request Method:** `POST`
8+
**Method:** `GET`
99

10-
**Request URL:** `/api/v1/account/info`
11-
12-
Send the request body with **Content-Type: application/json**.
13-
14-
## Header Request Example
15-
16-
```json
17-
{
18-
"api-key": "<YOUR_API_KEY>"
19-
}
20-
```
21-
22-
#### Parameter Description
23-
24-
| Parameter | Example Value | Type | Required | Description |
25-
| --------- | ------------- | ------ | -------- | ----------- |
26-
| api-key | - | String | Yes | API key |
10+
**Endpoint:** `/api/v1/account/info`
2711

2812
## Response Example
2913

@@ -34,18 +18,18 @@ Send the request body with **Content-Type: application/json**.
3418
"data": {
3519
"balance": "10122.5547",
3620
"traffic": 178194757135,
37-
"traffic_expiration_at": 1775267018
21+
"traffic_expires_at": 1775267018
3822
}
3923
}
4024
```
4125

42-
#### Parameter Description
26+
#### Response Fields
4327

44-
| Parameter | Example Value | Type | Description |
45-
| ------------------------ | ------------- | ------- | -------------------------------------------- |
46-
| code | 0 | Integer | [View help](/api/basic/base/#global-status-codes) |
47-
| message | success | String | Error description |
48-
| data | - | Object | - |
49-
| └─ balance | 10122.5547 | String | Account balance ($) |
50-
| └─ traffic | 178194757135 | Integer | Consumed traffic (bytes) |
51-
| └─ traffic_expiration_at | 1775267018 | Integer | Traffic expiration time (timestamp, seconds) |
28+
| Parameter | Example Value | Type | Description |
29+
| ------------------ | ------------- | ------- | ---------------------------------------------- |
30+
| code | 0 | Integer | [View help](/api/#global-status-codes) |
31+
| message | success | String | Response message |
32+
| data | - | Object | Response payload |
33+
| └─ balance | 10122.5547 | String | Account balance ($) |
34+
| └─ traffic | 178194757135 | Integer | Traffic quota in bytes |
35+
| └─ traffic_expires_at | 1775267018 | Integer | Traffic expiration time (timestamp, seconds) |

src/content/docs/api/basic/base.md

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

src/content/docs/api/basic/device-configuration.md

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

src/content/docs/api/basic/index.md

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

0 commit comments

Comments
 (0)