To minimize resource requirements for the development
environment, the help center's development server does
not run by default. Below are our recommendations for
accessing this help center page:
-
Quick reference: If you aren't planning to modify the help center, you can
view it on
zulip.com. Pages may be slightly behind the version
currently in
main.
-
Up-to-date reference: You can
view the current raw MDX file, which is recommended for documentation
that touches brand new or recently modified features.
-
Modifying the help center:
If you're making changes to the help center files, be sure to test and
provide screenshots in your pull request description. As with other code,
untested documentation is often buggy.
-
To run just the help center dev server without
running the rest of the metaopenchat app, use
./tools/run-dev --only-help-center.
-
To run the help center dev server alongside the
Zulip app, use
./tools/run-dev --help-center-dev-server (requires more resources).
-
To test help center search, run
./tools/build-help-center followed by
./tools/run-dev --help-center-static-build. Hot reloads won't
work: rerun ./tools/build-help-center
and reload your browser to see updates. Search will not
work with other methods of running the help center.