From dfc426a057c22db7a01bcf57f70f50e1fd329621 Mon Sep 17 00:00:00 2001
From: Shubham Padia <shubham@zulip.com>
Date: Tue, 25 Jun 2024 06:47:14 +0000
Subject: [PATCH] help-beta: Add development instructions and umbrella issue to
 README.

We also add the `run-dev` commands to `/devtools` page. The GitHub
issue link is duplicated between both, but it's a useful duplication
and the link is unlikely to change.
---
 help-beta/README.md                         | 12 ++++++++++
 templates/zerver/development/dev_tools.html | 26 +++++++++++++++++++++
 2 files changed, 38 insertions(+)
 create mode 100644 help-beta/README.md

diff --git a/help-beta/README.md b/help-beta/README.md
new file mode 100644
index 0000000000..ca40885900
--- /dev/null
+++ b/help-beta/README.md
@@ -0,0 +1,12 @@
+# Help center (beta) documentation
+
+This directory is part of an ongoing migration project to convert our
+help center documentation to use starlight and add search to the docs
+at the same time.
+
+The status of the project can be tracked at this umbrella issue:
+https://github.com/zulip/zulip/issues/30450
+
+If you are a developer, you can refer to `/devtools` page on your zulip
+installation to know what commands to use to run the project for
+development.
diff --git a/templates/zerver/development/dev_tools.html b/templates/zerver/development/dev_tools.html
index 0d36ab4cfa..ae865c6570 100644
--- a/templates/zerver/development/dev_tools.html
+++ b/templates/zerver/development/dev_tools.html
@@ -121,6 +121,32 @@
                 </ul>
             </li>
         </ul>
+        <h2>Development instructions for Help Center (Beta)</h2>
+        <p>
+            These commands are to run the project for an ongoing migration for our help center docs to use
+            <a href="https://github.com/withastro/starlight">@astrojs/starlight</a>. You can track the
+            progress for the project at <a href="https://github.com/zulip/zulip/issues/30450">#30450</a>.
+        </p>
+        <ul>
+            <li>
+                <code>./tools/build-help-center</code> will convert the existing help center MD files to MDX.
+                It will also create a production build for the converted MDX files. You can run
+                <code>./tools/convert-help-center-docs-to-mdx</code> to convert the files separately.
+                You can run <code>pnpm build</code> within the <code>help-beta</code> directory
+                to run the build step separately.
+            </li>
+            <li>
+                <code>./tools/run-dev --help-center</code> will host the generated build on
+                <code>/help-beta</code> url. You will need to have run the build steps before this step.
+                The docs search will work with this flag.
+            </li>
+            <li>
+                <code>./tools/run-dev --help-center-dev-server</code> will run a dev server at
+                <code>/help-beta</code> that supports hot reload. But, with this flag, the search will not work.
+                 This mode is ideal when you&#39;re editing a document and want to visualize the changes quickly.
+                You will need the converted MDX files to be already generated before you run this step.
+            </li>
+        </ul>
     </div>
 </div>