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 @@ +
+ These commands are to run the project for an ongoing migration for our help center docs to use + @astrojs/starlight. You can track the + progress for the project at #30450. +
+./tools/build-help-center
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
+ ./tools/convert-help-center-docs-to-mdx
to convert the files separately.
+ You can run pnpm build
within the help-beta
directory
+ to run the build step separately.
+ ./tools/run-dev --help-center
will host the generated build on
+ /help-beta
url. You will need to have run the build steps before this step.
+ The docs search will work with this flag.
+ ./tools/run-dev --help-center-dev-server
will run a dev server at
+ /help-beta
that supports hot reload. But, with this flag, the search will not work.
+ This mode is ideal when you'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.
+