Anders Kaseorg
b618c644a3
HTML validation: Quote <my-bot> and <api_key> placeholders in api docs.
...
They were being sent to the browser as non-renderable HTML tags.
Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2018-07-09 10:00:56 +05:30
Tim Abbott
9de80990ea
api: Update links for new /deploying-bots page.
...
Also caught by test-help-documentation.
2018-05-18 16:31:52 -07:00
Tim Abbott
dd7507c88a
docs: Add a page on deploying bots in production.
2018-05-18 16:13:17 -07:00
Tim Abbott
1f837340d1
api: Fix confusing documentation about services for botserver.
...
This fixes several super-confusing things in these docs. Bot services
aren't a user-facing concept, and also, you need the URL before
creating the bot users.
2018-05-14 09:21:45 -07:00
Tim Abbott
485d5b6335
api: Fix incorrectly coded bullet for zulip_botserver config.
2018-05-14 09:21:45 -07:00
Joshua Pan
e591668d60
bot-docs: Rewrite last section of "Running bots".
2018-05-14 04:27:36 -07:00
Joshua Pan
3952f94157
minor: Add missing period to bot-docs.
2018-05-14 04:27:36 -07:00
Joshua Pan
128aa8b7ee
bot-docs: Remove hint on "Running bots" doc.
...
We already explain testing bot output in
"Writing bots" doc, and the placement of
the hint itself doesn't make sense.
2018-05-14 04:27:36 -07:00
Joshua Pan
0b112cf5e9
bot-docs: Streamline introduction to 'Running a bot'.
2018-05-14 04:27:36 -07:00
Joshua Pan
2b06e1cec7
bot-docs: Renumber list to use all 1's.
2018-05-14 04:27:36 -07:00
Viraat Chandra
9284d32837
docs: Improve consistency and quality of API Documentation.
2018-03-01 08:21:53 -08:00
Robert Hönig
93f47fa700
outgoing webhooks: Rename "Base URL" to "Endpoint URL".
...
Based on user feedback. "Endpoint URL" gives a clearer
idea of the field's purpose.
2018-01-16 08:11:51 -05:00
akashnimare
db7943478e
api: Align code blocks properly in /api page.
...
Fixes #7395 .
2017-12-29 08:45:37 -05:00
YJDave
e4bf3d6907
api: Fix typo in interactive bots doc.
2017-12-14 00:53:23 -08:00
Steve Howell
4a6c3eeb98
Use realistic filepaths in zuliprc docs and hints.
...
The first part of this change is to have the "Your bots"
tooltip not lie about creating `.zuliprc`, because it
doesn't put a dot in front of the file.
And then the more significant change here is to make
the "Running a bot" documentation use realistic filepaths,
both in terms of where the download typically puts the file,
and where you want to move it to.
2017-11-21 07:32:24 -08:00
Tim Abbott
94d188fd7d
docs: Fix broken anchor links after API docs migration.
2017-11-17 15:56:05 -08:00
Mohd Ali Rizwi
2b858ab47b
api: Fix code blocks in headings.
...
These didn't look good, and were unnecessary.
Fixes part of #7395 .
Commit message tweaked by tabbott.
2017-11-17 11:03:08 -08:00
Tim Abbott
bf77ad3a6e
docs: Clean a few files of too-long lines.
...
We also document why the rest of them are still on the list.
2017-11-16 11:49:00 -08:00
Tim Abbott
9dd5d6e999
api: Fix broken links detected by new tests.
2017-11-15 10:12:59 -08:00
derAnfaenger
5ef09bfcd4
docs: Move bot docs to /api.
...
With a few fixes for rendering bugs. The rest will be in a follow-up
issue.
2017-11-15 09:58:29 -08:00