Anders Kaseorg
e015f3ed7d
docs: Correct “webapp” to “web app”.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-14 13:15:38 -07:00
Anders Kaseorg
544bbd5398
docs: Fix capitalization mistakes.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 09:57:26 -07:00
Anders Kaseorg
8cdf2801f7
python: Convert more variable type annotations to Python 3.6 style.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-05-08 16:42:43 -07:00
Alex Dehnert
ea670f3d61
docs: remove duplicate "make" in "Writing Bots".
2019-08-21 14:36:08 -07:00
Tim Abbott
0db9afe605
api docs: Update link to a currently running requestbin site.
2019-08-08 11:04:16 -07:00
Hemanth V. Alluri
ffd2bccd4e
openapi: Standardize URL format to use {var_name} syntax.
...
The previous code for the validator test was fairly messy due to
checking for both formats of the openapi url, one with
<variable_name> and the other with {variable_name}. To eliminate
this, we have standardized the format and restricted it to
{variable_name} as per the official format at:
https://swagger.io/docs/specification/describing-parameters .
2019-07-11 11:01:40 -07:00
Puneeth Chaganti
64ad031d5c
writing-bots: Use a fenced code block to fix rendering.
...
Type annotation for the function is not rendered correctly: `-> None` is
rendered as `-> None`.
2019-05-14 15:35:12 -07:00
Eeshan Garg
c6dd801525
docs: Fix a couple of broken links.
...
For the PHP link, I just found an equivalent link that detailed
some well-known PHP security vulnerabilities.
As for the now defunct RequestBin, another instance is hosted
by another domain, so we can recommend using that for now.
2018-11-06 12:54:36 -08:00
Rishi Gupta
c37384f63d
api docs: Update writing-bots.
...
Removes the intro material since there are better places for it.
2018-10-20 13:31:19 -07:00
Rishi Gupta
cd81b0766a
api docs: Move references to integration-guide to integrations-overview.
2018-10-16 21:06:59 -07:00
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
Eeshan Garg
7e379bbb76
writing-bots: Recommend using Python 3 to run tools/provision.
2018-05-03 10:11:49 -07:00
Viraat Chandra
9284d32837
docs: Improve consistency and quality of API Documentation.
2018-03-01 08:21:53 -08:00
Robert Hönig
12e7e2557e
writing-bots.md: Add fixture JSON skeleton.
2018-02-05 10:19:32 -08:00
Robert Hönig
7d977dd059
writing-bots.md: Remove obsolete bot_handler.storage disclaimer.
...
Permanent storage is now supported for external bots.
2018-02-05 10:19:32 -08:00
Steve Howell
a5e55cee9b
bot docs: Clean up "Testing a bot's output".
...
The main cleanup here is to move the examples out of the bulleted
list, which was getting rendered in an ugly/confusing way.
I also removed some redundant text, fixed some typos, and changed
the wording a bit.
2018-01-18 16:09:24 -05:00
Steve Howell
7b8cc396b5
bot docs: Simplify docs on writing bot tests.
...
These changes catch up to some recent improvements in the
test system, plus I eliminate some unnecessary sections.
2017-12-14 07:07:18 -05:00
YJDave
e4bf3d6907
api: Fix typo in interactive bots doc.
2017-12-14 00:53:23 -08:00
Greg Price
ca09c1e0fd
templates: Revert change to Python 3 typing syntax in examples.
...
This reverts commit 5a1869901
. I reviewed this change and decided not
to merge it yet, but then I did anyway <_< >_>, along with some others
in the same PR.
2017-12-12 17:45:43 -08:00
rht
5a1869901d
templates: Use Python 3 syntax for typing.
2017-12-12 17:42:54 -08:00
Nikhil Kumar Mishra
799bf58463
bot docs: Change zulip-bot-output to zulip-terminal.
...
Fixes #7734 .
2017-12-12 16:43:23 -06:00
derAnfaenger
41a2032d71
docs: Add 'requirements.txt' to bot structure outline.
2017-11-21 09:08:48 -08:00
Tim Abbott
94d188fd7d
docs: Fix broken anchor links after API docs migration.
2017-11-17 15:56:05 -08:00
derAnfaenger
73915a9631
docs: Move integration docs to /api.
2017-11-17 11:58:54 -08:00
Tim Abbott
026410dd1b
api: Fix a typo in an anchor tag URL.
2017-11-17 11:03:08 -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
07c2b205a4
docs: Update absolute links to point to new URLs.
...
This should get test-documentation and test-help-documentation passing
again after we moved everything around in the last commit.
There are a lot more absolute links (generally in code comments) to
update, but they are lower-priority and can be done in a follow-up
pass.
2017-11-16 10:08:22 -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