Skip to content

Commit

Permalink
feat: 添加教程文档索引
Browse files Browse the repository at this point in the history
Signed-off-by: Ke Jie <[email protected]>
  • Loading branch information
chzealot committed Sep 19, 2023
1 parent 2bdcfcb commit 633e75a
Show file tree
Hide file tree
Showing 15 changed files with 30 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/develop/sdk/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ sidebar_position: 1
* Java(示例,而不是SDK):https://github.com/open-dingtalk/dingtalk-stream-sdk-java-quick-start
* Node.js(SDK+示例):https://github.com/open-dingtalk/dingtalk-stream-sdk-nodejs
* Python(SDK+示例):https://github.com/open-dingtalk/dingtalk-stream-sdk-python
* Golang(SDK+示例):https://github.com/open-dingtalk/dingtalk-stream-sdk-go
* Go(SDK+示例):https://github.com/open-dingtalk/dingtalk-stream-sdk-go

更多语言 SDK 欢迎社区参与贡献,将在此页面中予以推荐展示,目前测试验证通过的生态 SDK 如下:

Expand Down
8 changes: 8 additions & 0 deletions docs/explore/tutorials/stream/bot/go/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Go",
"position": 1,
"link": {
"type": "generated-index",
"slug": "/explore/tutorials/stream/bot/go"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ go run echo_markdown.go --client_id="your-client-id" --client_secret="your-clien
```

:::caution 注意事项
务必将以上命令中"your-client-id"和"your-client-secret"替换成实际的值后再运行,否则无法成功建立连接。Client ID 和 Client Secret 可以通过[步骤二: 创建机器人应用文档](/docs/explore/tutorials/stream/bot/golang/create-bot)获取。
务必将以上命令中"your-client-id"和"your-client-secret"替换成实际的值后再运行,否则无法成功建立连接。Client ID 和 Client Secret 可以通过[步骤二: 创建机器人应用文档](/docs/explore/tutorials/stream/bot/go/create-bot)获取。
:::

至此,你已成功完成机器人服务开发和部署。接下来可以体验自己开发的机器人服务了。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ go run echo_streaming.go --client_id="your-client-id" --client_secret="your-clie
```

:::caution 注意事项
务必将以上命令中"your-client-id"和"your-client-secret"替换成实际的值后再运行,否则无法成功建立连接。Client ID 和 Client Secret 可以通过[步骤二: 创建机器人应用文档](/docs/explore/tutorials/stream/bot/golang/create-bot)获取。
务必将以上命令中"your-client-id"和"your-client-secret"替换成实际的值后再运行,否则无法成功建立连接。Client ID 和 Client Secret 可以通过[步骤二: 创建机器人应用文档](/docs/explore/tutorials/stream/bot/go/create-bot)获取。
:::

至此,你已成功完成机器人服务开发和部署。接下来可以体验自己开发的机器人服务了。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ sidebar_position: 4

## 建立调试群

你也可以在[步骤二: 创建机器人应用文档](/docs/explore/tutorials/stream/bot/golang/create-bot)中,在开启“机器人配置”的页面底部,找到一个“点击调试”的按钮。点击该按钮后,将会创建一个调试群,并自动将机器人安装到群中。扫码入群后,即可体验机器人能力。
你也可以在[步骤二: 创建机器人应用文档](/docs/explore/tutorials/stream/bot/go/create-bot)中,在开启“机器人配置”的页面底部,找到一个“点击调试”的按钮。点击该按钮后,将会创建一个调试群,并自动将机器人安装到群中。扫码入群后,即可体验机器人能力。
7 changes: 0 additions & 7 deletions docs/explore/tutorials/stream/bot/golang/_category_.json

This file was deleted.

3 changes: 2 additions & 1 deletion docs/explore/tutorials/stream/event/go/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"label": "Go",
"position": 2,
"link": {
"type": "generated-index"
"type": "generated-index",
"slug": "/explore/tutorials/stream/event/go"
}
}
3 changes: 2 additions & 1 deletion docs/explore/tutorials/stream/event/nodejs/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"label": "Node.js",
"position": 3,
"link": {
"type": "generated-index"
"type": "generated-index",
"slug": "/explore/tutorials/stream/event/nodejs"
}
}
18 changes: 13 additions & 5 deletions docs/explore/tutorials/stream/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,26 @@ sidebar_position: 1

# 概述

本文档介绍如何通过开发一个钉钉机器人,具备收发消息能力
钉钉 Stream 模式可以用于多种场景的回调,包括事件订阅、机器人接收消息、卡片回调等。该系列教程详细介绍如何从零开始接入各种能力

## 教程列表
## 机器人接收消息

通过学习本教程,你可以开发一个钉钉聊天机器人,具备以下能力:

* 接收聊天会话中的消息内容,包括单聊和群聊。备注:群聊仅限 AT 机器人的消息。
* 回复消息,或者主动发送消息到聊天会话中

| 教程 | GitHub 代码仓库 |
|-------------------------------------------------------|---|
| [Go](/docs/explore/tutorials/stream/bot/golang/intro) | https://github.com/open-dingtalk/dingtalk-tutorial-go |
| 教程 | GitHub 代码仓库 |
|----------------------------------------------|---|
| [Go 教程文档](/docs/explore/tutorials/stream/bot/go) | https://github.com/open-dingtalk/dingtalk-tutorial-go |

## 事件订阅

| 教程 | GitHub 代码仓库 |
|-------------------------------------------------------------|-----------------------------------------------------------|
| [Go 教程文档](/docs/explore/tutorials/stream/event/go) | https://github.com/open-dingtalk/dingtalk-tutorial-go |
| [Node.js 教程文档](/docs/explore/tutorials/stream/event/nodejs) | https://github.com/open-dingtalk/dingtalk-tutorial-nodejs |


## 进一步学习

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/stream/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ sidebar_position: 99

## 是否支持 .NET、PHP?

当前官方 SDK 支持 Java、Python、Node.js、Golang,其他针对其他语言我们提供了协议文档,便于开发者自行实现。
当前官方 SDK 支持 Java、Python、Node.js、Go,其他针对其他语言我们提供了协议文档,便于开发者自行实现。

详见:[钉钉 SDK 概述](/docs/develop/sdk/overview)

Expand Down

0 comments on commit 633e75a

Please sign in to comment.