Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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.
This commit is contained in:
Shubham Padia 2024-06-25 06:47:14 +00:00 committed by Tim Abbott
parent 72f7a13346
commit dfc426a057
2 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
help-beta/README.md Normal file
View File

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

26
templates/zerver/development/dev_tools.html
View File

@ -121,6 +121,32 @@
</ul> </ul>
</li> </li>
</ul> </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>
</div> </div>