diff --git a/docs/documentation/api.md b/docs/documentation/api.md index 81aa313ed4..93e172fa43 100644 --- a/docs/documentation/api.md +++ b/docs/documentation/api.md @@ -57,7 +57,7 @@ Our API documentation is defined by a few sets of files: - The cURL examples are generated and tested using `zerver/openapi/curl_param_value_generators.py`. - The REST API index - (`templates/zerver/help/include/rest-endpoints.md`) in the broader + (`templates/zerver/api/include/rest-endpoints.md`) in the broader /api left sidebar (`templates/zerver/api/sidebar_index.md`). This first section is focused on explaining how the API documentation @@ -296,7 +296,7 @@ above. template, so only do this if there's a good reason. 1. Add the endpoint to the index in - `templates/zerver/help/include/rest-endpoints.md`. The URL should + `templates/zerver/api/include/rest-endpoints.md`. The URL should match the `operationId` for the endpoint, and the link text should match the title of the endpoint from the OpenAPI `summary` field. diff --git a/templates/zerver/help/include/api-admin-only.md b/templates/zerver/api/include/api-admin-only.md similarity index 100% rename from templates/zerver/help/include/api-admin-only.md rename to templates/zerver/api/include/api-admin-only.md diff --git a/templates/zerver/help/include/empty.md b/templates/zerver/api/include/empty.md similarity index 100% rename from templates/zerver/help/include/empty.md rename to templates/zerver/api/include/empty.md diff --git a/templates/zerver/help/include/rest-endpoints.md b/templates/zerver/api/include/rest-endpoints.md similarity index 100% rename from templates/zerver/help/include/rest-endpoints.md rename to templates/zerver/api/include/rest-endpoints.md diff --git a/templates/zerver/documentation_main.html b/templates/zerver/documentation_main.html index 01294edd58..f6bd8cf2b7 100644 --- a/templates/zerver/documentation_main.html +++ b/templates/zerver/documentation_main.html @@ -17,6 +17,8 @@ {% if page_is_policy_center %} {{ render_markdown_path(sidebar_index, pure_markdown=True) }} + {% elif page_is_help_center %} + {{ render_markdown_path(sidebar_index, context=api_uri_context, help_center=True) }} {% else %} {{ render_markdown_path(sidebar_index, api_uri_context) }} {% endif %} @@ -35,6 +37,8 @@