Commit Graph

8 Commits

Author SHA1 Message Date
Lauryn Menard
214008e92d api-docs: Move zuliprc file documentation to API keys article.
As zuliprc files are in a standard format that you can access from
any programming language, not just Python, it makes more sense to
have them documented with the information about API keys.

Fixes #10670.
2026-04-05 15:00:57 -07:00
Lauryn Menard
94628b791d api-docs: Add notes about mobile client logout with new API key.
Updates the API documentation article for API keys to note that
generating a new API key will logout the account from any mobile
clients.

Updates the API key modal in the web app with a similar note.

We already note this in the help center article on protecting your
account, which has a section about generating a new API key.
2026-03-22 07:57:28 -07:00
Lauryn Menard
6066b43a3a api-docs: Update instructions for changes to bot management panel. 2025-12-03 13:08:18 -08: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
96daef400e api-docs: Update "API keys".
Updates API doc to follow current help center documentation patterns.

Fixes #28876.
2024-02-24 08:14:32 -08:00
David Rosa
9a6ccba733 account-settings: Rename "API key" button.
Renames button to "Manage your API key", and updates docs
accordingly.

Fixes part of #28881.
2024-02-23 09:43:57 -08:00
Manas Jayaswal
3e24a05e66
settings: Improve wording of "Show API key" modal.
This commit changes the "Show API key" modal to use a more intuitive
description of the user's password field, and also to put the reset password
option, which should be the less common case, at the end.

Fixes: #24506.
2023-03-08 18:48:37 -08: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