You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit adb3d79
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+32-3Lines changed: 32 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,10 @@ Provider-agnostic setup guides for AI coding tools (Codex, Claude Code, OpenCode
4
4
5
5
The docs are open to everyone: examples use KunCode as a reference address, but every step applies to any compatible gateway or official API. Using KunCode is not required.
@@ -32,10 +36,35 @@ The workflow injects `BASE_PATH=/<repo-name>/` so project pages resolve correctl
32
36
docs/
33
37
index.md # Chinese home
34
38
guide/ # Chinese getting started
39
+
index.md # overview / three-step setup
40
+
api-key.md # create and copy an API key
41
+
endpoints.md # pick the right protocol endpoint
42
+
concepts.md # API keys, groups, channels, ratios, quota
43
+
models.md # list models, capabilities, per-tool requirements
44
+
errors.md # error codes and troubleshooting
35
45
tools/ # Chinese per-tool guides
46
+
codex.md
47
+
claude-code.md
48
+
opencode.md
36
49
faq.md
37
-
en/ # English mirror
38
-
public/ # static assets
50
+
en/ # English mirror of the same tree
51
+
public/ # static assets (images, logo, favicon)
39
52
```
40
53
41
-
Add a new tool by copying `docs/tools/opencode.md` and its English counterpart, then registering both in `docs/.vitepress/config.mts`.
54
+
Chinese pages live at the root (`docs/guide/...`); the English mirror lives under `docs/en/...` with the same filenames. When you add or edit a page, update both sides.
55
+
56
+
## Writing a new tool page
57
+
58
+
1. Copy an existing page such as `docs/tools/opencode.md` to `docs/tools/<tool>.md`.
59
+
2. Copy `docs/en/tools/opencode.md` to `docs/en/tools/<tool>.md` and translate it.
60
+
3. Register both in the `zhSidebar` / `enSidebar` arrays in `docs/.vitepress/config.mts`, under the right protocol group (OpenAI-compatible or Anthropic-compatible).
61
+
4. Add it to the tool table in `docs/tools/index.md` and `docs/en/tools/index.md`.
62
+
5. Put screenshots under `docs/public/images/<tool>/` and reference them as `/images/<tool>/<name>.png`.
63
+
6. Run `bun run build` before committing.
64
+
65
+
## Conventions
66
+
67
+
- Every Chinese page has an English counterpart with the same path under `docs/en/`.
68
+
- Screenshots live under `docs/public/images/<section>/` and are shared by both languages.
69
+
- Keep the reference address in examples as `https://kuncode.120403.xyz`, but note that it is replaceable.
70
+
- Internal links use root-absolute paths with the right locale prefix, e.g. `/guide/errors` and `/en/guide/errors`.
0 commit comments