Commit Graph

622 Commits

Author SHA1 Message Date
derAnfaenger 41a2032d71 docs: Add 'requirements.txt' to bot structure outline. 2017-11-21 09:08:48 -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
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 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 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
Tim Abbott 54aa87fba3 api: Migrate to using the new version of the API site. 2017-11-10 17:56:22 -08:00
Tim Abbott 0386c674cb api: Fill out the sidebar with sections.
Most of these should be migrated from ReadTheDocs to this new site.
2017-11-08 13:15:41 -08:00
Tim Abbott a8c735e1d2 /api/: Fix some headings. 2017-11-08 13:08:23 -08:00
Brock Whittaker d2e55fa5c8 /api/ & /help/: Change index to <h1>.
The Index should be presented as an <h1> section and to the far left.
2017-11-08 13:01:33 -08:00
Tim Abbott 5703b38ffb api: Move usage instructions to their own page. 2017-11-08 10:29:24 -08:00
Tim Abbott c869ed2c3b api-docs: Extract installation instructions to their own section. 2017-11-08 10:01:48 -08:00
Tim Abbott 67d85caf34 api-docs: Clean up reference to bin/ in the tarball. 2017-11-08 09:44:55 -08:00
Tim Abbott ac63be7a0c api-docs: Fix space in zulip-send instructions. 2017-11-08 09:43:41 -08:00
Eeshan Garg 7c113f0447 api-docs: Render api_url in /api docs.
In templates/zerver/api/main.html, since the current context isn't
passed to render_markdown_path when rendering an article,
render_markdown_path doesn't have the context to render values such
as api_url. This commit makes sure that it does by passing a dict
called api_uri_context to render_markdown_path when rendering an
article.
2017-11-08 01:29:49 -03:30
Eeshan Garg 6d48601f40 api-docs: Use proper indentation for code blocks. 2017-11-08 01:13:19 -03:30
Tim Abbott f01f596138 help: Merge api.js and help.js bundles to fix code blocks.
In addition to decreasing the excessive number of bundles we had, this
will set us up to fix rendering of code blocks when clicking the
sidebar links in the /api-new site.
2017-10-30 22:53:17 -07:00
Brock Whittaker e86e259cb1 /api/: Add Markdown-based /api-new documentation.
This commit allows for the /api-new/ page to rendered similarly to our
/help pages.  It's based on the old content for /api, but we're not
replacing the old content yet, to give a bit of time to restructure
things reasonably.

Tweaked by eeshangarg and tabbott.
2017-10-30 22:32:43 -07:00