Skip to content

Commit

Permalink
add howto
Browse files Browse the repository at this point in the history
  • Loading branch information
seven1240 committed Jan 22, 2024
1 parent 8051d90 commit 59d57e0
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/rts/howto/add-docs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# 如何向 RTS 文件中添加文档?

RTS 文件在 Github 上,首先你要有个 Github 账号,然后 Fork 并 Clone RTS 文档仓库:<https://github.com/rts-cn/docs>

本文件使用 <https://docusaurus.io/> 系统构建,Clone 后向 `docs/rts/` 目录中添加文档。扩展名使用`.mdx`,使用 Markdown 语法,参见[小樱桃的 Markdown 规范](https://docs.xswitch.cn/xpedia/markdown/)

向索引页 `howto/index.mdx` 上添加指向新文件的链接,如 `[如何向RTS文件中添加文档](add-docs/),注意,内部链接最后要有个`/`。

然后提交 Pull Request。参见:

- [如何向开源项目提交 pr,完成人生中第一次代码贡献](https://juejin.cn/post/7021727244124962846)
- [如何在 Github 上规范的提交 PR(图文详解](https://zhuanlan.zhihu.com/p/584834288)

如果需要在本地预览或编译,需要安装 Node.JS 环境。执行`yarn`安装依赖,执行`yarn start`可以启动一个本地的 Server,然后可以根据提示信息打开 `http://localhost:3000` 预览。

更多信息参见 <https://github.com/rts-cn/docs> 上的 README,以及 [docusaurus 中文文档](https://docusaurus.io/zh-CN/docs/)。
11 changes: 11 additions & 0 deletions docs/rts/howto/inband-dtmf.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# 如果在 RTS 中使用 inband DTMF

inband DTMF 即带内 DTMF。

## 问题提出

A leg 呼入 RTS,在 RTS 中 bridge B leg,希望向 B leg 发送 inband DTMF 即带内 DTMF。

## 实现方法

todo.
6 changes: 6 additions & 0 deletions docs/rts/howto/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# RTS How-To

这是一个 RTS How-To 索引页,收集 RTS 中“如何做”的案例。

- [如何向 RTS 文档中添加文档](add-docs/)
- [如何在 RTS 中使用 inband DTMF?](inband-dtmf/)

0 comments on commit 59d57e0

Please sign in to comment.