-
-
Notifications
You must be signed in to change notification settings - Fork 8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use tables in developer docs #9610
Comments
Hello @zulip/server-development members, this issue was labeled with the "area: documentation (developer)" label, so you may want to check it out! |
@zulipbot claim |
Hello @jdimaria3! Thanks for your interest in Zulip! You have attempted to claim an issue without the labels "help wanted", "good first issue". Since you're a new contributor, you can only claim and submit pull requests for issues with the help wanted or good first issue labels. If this is your first time here, we recommend reading our guide for new contributors before getting started. |
I opened #19548 migrating to MyST-Parser. This allows us to use GFM-style tables (and I converted the one reST table we have). |
Our https://zulip.readthedocs.io/ developer documentation is in Markdown files in
docs/
, rendered into HTML using Sphinx. Per readthedocs/recommonmark#3 (comment) , we can now use tables in our docs by using thesphinx-markdown-tables
Sphinx extension (source: https://github.com/ryanfox/sphinx-markdown-tables ).Maybe we should use this. Some of our bullet lists would perhaps be easier to read as tables. Examples:
The text was updated successfully, but these errors were encountered: