From 610f8b42c36b1fbe098601d04c23fa3e67e90486 Mon Sep 17 00:00:00 2001 From: Niloth P <20315308+Niloth-p@users.noreply.github.com> Date: Wed, 26 Mar 2025 10:16:47 +0530 Subject: [PATCH] docs: Reference the new templates directory for PythonAPIIntegrations. Mention the new templates directory `static/generated/integrations`, and the script that generates them, in the doc on documenting integrations. --- docs/documentation/integrations.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/documentation/integrations.md b/docs/documentation/integrations.md index 756798ede1..10b54a00cd 100644 --- a/docs/documentation/integrations.md +++ b/docs/documentation/integrations.md @@ -8,7 +8,18 @@ integrations involves writing Markdown files, either at `templates/zerver/integrations/{integration_name}.md` (for other integrations). -Usually, this involves a few steps: +The [integrations][api-integrations] in +[zulip/python-zulip-api][api-repo] have their corresponding Markdown files +at `zulip/integrations/{integration_name}/doc.md`, which are imported into +[zulip/zulip][zulip-repo] at +`static/generated/integrations/{integration_name}/doc.md` using the +`tools/setup/generate_bots_integrations_static_files.py` script. + +[api-repo]: https://github.com/zulip/python-zulip-api/ +[api-integrations]: https://github.com/zulip/python-zulip-api/tree/main/zulip/integrations +[zulip-repo]: https://github.com/zulip/zulip + +Typically, the documentation process involves the following steps: - Add text explaining all of the steps required to set up the integration, including what URLs to use, etc. See