From a87749b4789258bfacd23402f7541c335a378cc6 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Tue, 11 May 2021 22:00:05 -0700 Subject: [PATCH] api docs: Avoid confusing the API changelog with the changelog. We change the title to be more descriptive and also link to the overall Zulip changelog, since one can reasonably get to this page when googling for "Zulip changelog". --- templates/zerver/api/changelog.md | 7 +++++-- templates/zerver/api/sidebar_index.md | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/templates/zerver/api/changelog.md b/templates/zerver/api/changelog.md index 51c972b062..ddad8c2221 100644 --- a/templates/zerver/api/changelog.md +++ b/templates/zerver/api/changelog.md @@ -1,6 +1,7 @@ -# Changelog +# API Changelog -This page documents changes to the Zulip Server API over time. +This page documents changes to the Zulip Server API over time. See also +the [Zulip server changelog][server-changelog]. The recommended way for a client like the Zulip mobile or desktop apps that needs to support interaction with a wide range of different Zulip @@ -579,3 +580,5 @@ No changes; feature level used for Zulip 3.0 release. * [`POST /register`](/api/register-queue): Added `slim_presence` parameter. Changes the format of presence events, but is still being changed and should not be used by clients. + +[server-changelog]: https://zulip.readthedocs.io/en/latest/overview/changelog.html diff --git a/templates/zerver/api/sidebar_index.md b/templates/zerver/api/sidebar_index.md index 62412c78b2..a3f82b98fd 100644 --- a/templates/zerver/api/sidebar_index.md +++ b/templates/zerver/api/sidebar_index.md @@ -20,6 +20,6 @@ * [Configuring the Python bindings](/api/configuring-python-bindings) * [Error handling](/api/rest-error-handling) * [Client libraries](/api/client-libraries) -* [Changelog](/api/changelog) +* [API Changelog](/api/changelog) {!rest-endpoints.md!}