From 11d8876fa76a6b8228b7e2ed67421e0502cd4947 Mon Sep 17 00:00:00 2001 From: Richard Chien Date: Thu, 16 Aug 2018 00:49:33 +0800 Subject: [PATCH] Update docs --- docs/.vuepress/config.js | 6 +++--- docs/guide/README.md | 4 ++-- ...group-management.md => handling-notices-and-requests.md} | 2 +- docs/guide/whats-next.md | 2 +- docs/guide/{write-commands.md => writing-commands.md} | 0 .../{write-nl-processors.md => writing-nl-processors.md} | 0 6 files changed, 7 insertions(+), 7 deletions(-) rename docs/guide/{group-management.md => handling-notices-and-requests.md} (83%) rename docs/guide/{write-commands.md => writing-commands.md} (100%) rename docs/guide/{write-nl-processors.md => writing-nl-processors.md} (100%) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 70328d4f..c0f0def7 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -29,10 +29,10 @@ module.exports = { 'getting-started', 'whats-happened', 'basic-configurations', - 'write-commands', - 'write-nl-processors', + 'writing-commands', + 'writing-nl-processors', 'tuling', - 'group-management', + 'handling-notices-and-requests', 'whats-next', ] } diff --git a/docs/guide/README.md b/docs/guide/README.md index 513965e7..96a5a186 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -1,11 +1,11 @@ -# 介绍 +# 概览 ::: tip 提示 如果在阅读本文档时遇到难以理解的词汇，请随时查阅 [术语表](/glossary.md) 或使用 [Google 搜索](https://www.google.com/ncr)。 ::: ::: tip 提示 -初次使用时可能会觉得这里的介绍过于枯燥，可以先简单略读之后直接前往 [安装](/guide/installation.md) 查看安装方法，并进行后续的基础使用教程。 +初次使用时可能会觉得这里的概览过于枯燥，可以先简单略读之后直接前往 [安装](/guide/installation.md) 查看安装方法，并进行后续的基础使用教程。 ::: NoneBot 是一个基于 [酷 Q](https://cqp.cc/) 的 Python 异步 QQ 机器人框架，它会对 QQ 机器人收到的消息进行解析和处理，并以插件化的形式，分发给消息所对应的命令处理器和自然语言处理器，来完成具体的功能。 diff --git a/docs/guide/group-management.md b/docs/guide/handling-notices-and-requests.md similarity index 83% rename from docs/guide/group-management.md rename to docs/guide/handling-notices-and-requests.md index 591024fa..595f5cf9 100644 --- a/docs/guide/group-management.md +++ b/docs/guide/handling-notices-and-requests.md @@ -1,3 +1,3 @@ -# 编写通知和请求处理器 +# 处理通知和请求 本章将以一个具有自动同意或拒绝入群请求、欢迎新成员、禁言不良成员等功能的群管插件为例，来教你编写通知和请求处理器。 diff --git a/docs/guide/whats-next.md b/docs/guide/whats-next.md index 5dbe1139..d730279e 100644 --- a/docs/guide/whats-next.md +++ b/docs/guide/whats-next.md @@ -2,6 +2,6 @@ 在阅读完前面的入门指南之后，你已经具备了实现具有复杂功能的 QQ 机器人的基本知识，可以开始编写完整的作品了。 -然而，NoneBot 并不止步于此。在使用 NoneBot 编写功能时，你可能会时常遇到一些绝佳的想法，但这些想法在已有的基本知识的基础上无法实现。幸运的是，NoneBot 已经预先考虑到了大多数这类使用场景，并提供了相应的接口来帮助实现你想要的逻辑。 +然而，NoneBot 并不止步于此。在使用 NoneBot 编写功能时，你可能会时常遇到一些绝佳的想法，但这些想法在已有的基本知识的基础上无法实现。幸运的是，NoneBot 已经预先为大多数这样的使用场景提供了相应的接口，以帮助你实现想要的逻辑。 NoneBot 的这部分用法我们称之为进阶用法，关于进阶用法的介绍，见 [进阶](/advanced/)。通常，你不需要在初次使用时就掌握进阶用法，而是建议在实际编程中发现有需要时再去查阅。 diff --git a/docs/guide/write-commands.md b/docs/guide/writing-commands.md similarity index 100% rename from docs/guide/write-commands.md rename to docs/guide/writing-commands.md diff --git a/docs/guide/write-nl-processors.md b/docs/guide/writing-nl-processors.md similarity index 100% rename from docs/guide/write-nl-processors.md rename to docs/guide/writing-nl-processors.md