docs: Move bot docs to /api.

With a few fixes for rendering bugs.  The rest will be in a follow-up
issue.
This commit is contained in:
derAnfaenger 2017-11-15 11:49:15 +01:00 committed by Tim Abbott
parent da67c610b2
commit 5ef09bfcd4
5 changed files with 11 additions and 12 deletions

View File

@ -82,8 +82,6 @@ Contents:
integration-guide
integration-docs-guide
webhook-walkthrough
running-bots-guide
writing-bots-guide
new-feature-tutorial
writing-views
life-of-a-request

View File

@ -22,7 +22,7 @@ https://github.com/zulip/python-zulip-api/tree/master/zulip_bots/zulip_bots/bots
in your Zulip organization.
*Hint: Looking for an easy way to test a bot's output? Check out [this](
writing-bots-guide.html#testing-a-bot-s-output) guide.*
writing-bots#testing-a-bots-output) guide.*
You need:
@ -38,10 +38,10 @@ You need:
1. Run `pip install zulip_bots` to install the package.
*Hint: Do you want to install the latest development version? Check
out [this](
writing-bots-guide.html#installing-a-development-version-of-the-zulip-bots-package)
guide.*
*Hint: Do you want to install the latest development version? Check
out [this](
writing-bots#installing-a-development-version-of-the-zulip-bots-package)
guide.*
2. Register a new bot user on the Zulip server's web interface.
@ -54,7 +54,7 @@ You need:
* In the *Active bots* panel, click on the little green download icon
to download its configuration file *.zuliprc* (the structure of this file is
explained [here](writing-bots-guide.html#configuration-file)).
explained [here](writing-bots#configuration-file)).
* Copy the file to a destination of your choice, e.g. to `~/.zuliprc`.
4. Run the bot.

View File

@ -17,5 +17,5 @@
## Interactive bots (experimental)
* [Running bots](https://zulip.readthedocs.io/en/latest/running-bots-guide.html)
* [Writing bots](https://zulip.readthedocs.io/en/latest/writing-bots-guide.html)
* [Running bots](/api/running-bots)
* [Writing bots](/api/writing-bots)

View File

@ -12,9 +12,10 @@ third-party service.
* This guide is about writing and testing interactive bots. We assume
familiarity with our
[guide for running bots](running-bots-guide.html).
[guide for running bots](running-bots).
On this page you'll find:
* A step-by-step
[guide](#installing-a-development-version-of-the-zulip-bots-package)
on how to set up a development environment for writing bots with all

View File

@ -651,7 +651,7 @@ def build_custom_checkers(by_lang):
color = next(colors)
markdown_docs_length_exclude = {
"api/bots/converter/readme.md",
"docs/running-bots-guide.md",
"templates/zerver/api/running-bots.md",
"docs/dev-env-first-time-contributors.md",
"docs/webhook-walkthrough.md",
"docs/life-of-a-request.md",