Skip to content

Commit 77faa5e

Browse files
committed
Reorganize docs by language
1 parent 075e50d commit 77faa5e

22 files changed

+63
-38
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
| English - [简体中文](README.zh.md) - [繁體中文](README.zh.hant.md) |
1111
|:---:|
12-
| [Documentation](docs/) - [C++ API](docs/cpp-api.md) - [Examples](docs/examples.md) |
12+
| [Documentation](docs/README.md) - [English Docs](docs/en/README.md) - [中文文档](docs/zh/README.md) - [繁體中文文件](docs/zh-hant/README.md) |
1313

1414
`llmapi` provides a typed `Client<Provider>` API for chat, streaming, embeddings, tool calls, and conversation persistence. The default config alias `Config` maps to OpenAI-style providers, so the common case does not need an explicit `openai::OpenAI` wrapper.
1515

@@ -89,7 +89,7 @@ target("demo")
8989
add_packages("llmapi")
9090
```
9191

92-
See [docs/getting-started.md](docs/getting-started.md) and [docs/providers.md](docs/providers.md) for more setup detail.
92+
See [docs/en/getting-started.md](docs/en/getting-started.md) and [docs/en/providers.md](docs/en/providers.md) for more setup detail.
9393

9494
## License
9595

README.zh.hant.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
| [English](README.md) - [简体中文](README.zh.md) - 繁體中文 |
1111
|:---:|
12-
| [中文文件](docs/README.zh.hant.md) - [C++ API](docs/cpp-api.zh.hant.md) - [範例](docs/examples.zh.hant.md) |
12+
| [文件導覽](docs/README.md) - [繁體中文文件](docs/zh-hant/README.md) - [English Docs](docs/en/README.md) - [简体中文文档](docs/zh/README.md) |
1313

1414
`llmapi` 提供型別化的 `Client<Provider>` API,涵蓋聊天、串流輸出、embeddings、工具呼叫與對話持久化。預設別名 `Config` 對應 OpenAI 風格設定,常見情況下不需要顯式寫出 `openai::OpenAI(...)`
1515

@@ -89,7 +89,7 @@ target("demo")
8989
add_packages("llmapi")
9090
```
9191

92-
更多內容見 [docs/getting-started.zh.hant.md](docs/getting-started.zh.hant.md)[docs/providers.zh.hant.md](docs/providers.zh.hant.md)
92+
更多內容見 [docs/zh-hant/getting-started.md](docs/zh-hant/getting-started.md)[docs/zh-hant/providers.md](docs/zh-hant/providers.md)
9393

9494
## 授權
9595

README.zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
| [English](README.md) - 简体中文 - [繁體中文](README.zh.hant.md) |
1111
|:---:|
12-
| [中文文档](docs/README.zh.md) - [C++ API](docs/cpp-api.zh.md) - [示例](docs/examples.zh.md) |
12+
| [文档导航](docs/README.md) - [中文文档](docs/zh/README.md) - [English Docs](docs/en/README.md) - [繁體中文文件](docs/zh-hant/README.md) |
1313

1414
`llmapi` 提供类型化的 `Client<Provider>` API,覆盖聊天、流式输出、嵌入、工具调用与对话持久化。默认别名 `Config` 对应 OpenAI 风格配置,常见场景不需要显式写 `openai::OpenAI(...)`
1515

@@ -89,7 +89,7 @@ target("demo")
8989
add_packages("llmapi")
9090
```
9191

92-
更多内容见 [docs/getting-started.zh.md](docs/getting-started.zh.md)[docs/providers.zh.md](docs/providers.zh.md)
92+
更多内容见 [docs/zh/getting-started.md](docs/zh/getting-started.md)[docs/zh/providers.md](docs/zh/providers.md)
9393

9494
## 许可证
9595

docs/README.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,7 @@
1-
# llmapi Documentation
1+
# Documentation
22

3-
Current documentation for the `llmapi` C++23 module library.
3+
Select a language:
44

5-
## Contents
6-
7-
- [Getting Started](getting-started.md) - install, build, and first request
8-
- [C++ API Guide](cpp-api.md) - types, providers, and `Client<P>`
9-
- [Examples](examples.md) - chat, streaming, embeddings, and tool flows
10-
- [Providers](providers.md) - OpenAI, Anthropic, and compatible endpoints
11-
- [Advanced Usage](advanced.md) - persistence, async calls, and custom configuration
12-
13-
## What The Library Provides
14-
15-
- C++23 modules via `import mcpplibs.llmapi`
16-
- Typed chat messages and multimodal content structs
17-
- Provider concepts for sync, async, streaming, and embeddings
18-
- Built-in OpenAI and Anthropic providers
19-
- OpenAI-compatible endpoint support through configurable base URLs
20-
- Conversation save/load helpers for local session persistence
21-
22-
## License
23-
24-
Apache-2.0 - see [LICENSE](../LICENSE)
5+
- [English](en/README.md)
6+
- [简体中文](zh/README.md)
7+
- [繁體中文](zh-hant/README.md)

docs/en/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# llmapi Documentation
2+
3+
Current documentation for the `llmapi` C++23 module library.
4+
5+
Language:
6+
7+
- English
8+
- [简体中文](../zh/README.md)
9+
- [繁體中文](../zh-hant/README.md)
10+
11+
## Contents
12+
13+
- [Getting Started](getting-started.md) - install, build, and first request
14+
- [C++ API Guide](cpp-api.md) - types, providers, and `Client<P>`
15+
- [Examples](examples.md) - chat, streaming, embeddings, and tool flows
16+
- [Providers](providers.md) - OpenAI, Anthropic, and compatible endpoints
17+
- [Advanced Usage](advanced.md) - persistence, async calls, and custom configuration
18+
19+
## What The Library Provides
20+
21+
- C++23 modules via `import mcpplibs.llmapi`
22+
- Typed chat messages and multimodal content structs
23+
- Provider concepts for sync, async, streaming, and embeddings
24+
- Built-in OpenAI and Anthropic providers
25+
- OpenAI-compatible endpoint support through configurable base URLs
26+
- Conversation save/load helpers for local session persistence
27+
28+
## License
29+
30+
Apache-2.0 - see [LICENSE](../../LICENSE)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)