Commit Graph

6 Commits

Author SHA1 Message Date
Niloth P
7900770135 api_docs: Update instructions to deploy bots using Botserver.
"Deploying multiple bots" section:
- Simplified the `botserverrc` description, and removed 2 redundant code
blocks.
- Added the `bot-config-file` option to the `botserverrc` section
example, with a short description.
- Edited the previously vague instruction to download the `botserverrc`.
- Fixed the incomplete command to run Botserver.
- Updated the download instructions to link to the Personal Bots tab
directly.
- Added the bot-config-file setting to the botserverrc example, with a
tip on its usage.

"Create a bot" section:
- Added a separate section with an instruction block for creating
outgoing webhook bots.
- Added instructions similar to `/help/add-a-bot-or-integration`, but
avoided linking directly to the help doc to avoid too many link jumps.

"How Botserver works" section:
- Replaced the confusing Botserver example URL with a description.
- Removed the example of the normal functioning of bot code.

Co-authored-by: Lauryn Menard <lauryn@zulip.com>
Co-authored-by: mpagler <167506943+mpagler@users.noreply.github.com>
2025-04-08 10:48:13 -07:00
Lauryn Menard
2bb037f2a0 api-docs: Add comma to all uses of "e.g." in API docs. 2024-07-05 15:36:24 -07:00
Sayam Samal
19a7dae8aa docs: Update the gear menu icon.
This commit updates the /help and /api docs to reflect the new gear
menu icon introduced in bc3d486.
2024-04-23 09:24:02 -07:00
David Rosa
3c0cb4c6a2 api-docs: Use start_tabs formatting and add "Related articles".
- Updates API docs that have numbered instructions to use the
  `{start_tabs}` formatting we use in the help center.
- Cleans up formatting and revises documentation that shouldn't
  be formatted as a numbered instructions block.
- Cross-links related articles.

Fixes #28876.
2024-02-24 08:14:32 -08:00
David Rosa
992f5b3f6f api docs: Rename "private message" -> "direct message".
Updates instances of "private message" and "PM", avoiding acronyms.
2023-06-23 14:36:16 -07:00
Lauryn Menard
dbacc00f0f api-docs: Move markdown files to top level directory.
- Updates `.prettierignore` for the new directory.
- Updates any reference to the API documentation directory for
  markdown files to be `api_docs/` instead of `zerver/api/`.
- Removes a reference link from `docs/documentation/api.md` that
  hasn't referenced anything in the text since commit 0542c60.
- Update rendering of API documentation for new directory.
2023-02-02 17:25:40 -08:00