paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 16:14:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

api-docs: Move include markdown macro files for API documentation.

Browse Source 
Moves files in `templates/zerver/help/include` that are used
specifically for API documentation pages to be in a new directory:
`templates/zerver/api/include`.

Adds a boolean parameter to `render_markdown_path` to be used
for help center documentation articles.

Also moves the test file `empty.md` to the new directory since
this is the default directory for these special include macros
that are used in documentation pages.
This commit is contained in:
Lauryn Menard
2022-12-07 19:41:17 +01:00
committed by Tim Abbott
parent 5f9dc76d54
commit 6759767b14
7 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/documentation/api.md
View File

@@ -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.