zulip

History

Tim Abbott 85798e2b2c Dramatically expand directory structure docs.		2016-06-23 14:01:54 -07:00
..
_static	Add CSS style override for RTD to make tables use word wrapping	2015-08-19 11:52:49 -07:00
images	Improve first-time contributor docs.	2016-05-31 07:47:45 -07:00
.gitignore	Initial sphinx setup from sphinx-quickstart	2015-08-18 17:31:32 -07:00
Makefile	Initial sphinx setup from sphinx-quickstart	2015-08-18 17:31:32 -07:00
README.md	Remove references to requirements.txt.	2016-06-21 07:48:24 -07:00
architecture-overview.md	Convert architecture overview from rST to md for consistency.	2016-06-04 22:27:00 -07:00
changelog.md	Add changelog for Zulip 1.3.13 release.	2016-06-21 16:59:48 -07:00
code-contribution-checklist.rst	Add new documentation on Zulip settings system.	2016-06-17 12:15:15 -07:00
code-style.md	docs/code-style.md: Use ASCII spaces consistently.	2016-06-17 11:33:41 -07:00
conf.py	Make docs/conf.py pass mypy check.	2016-05-25 15:04:39 -07:00
directory-structure.md	Dramatically expand directory structure docs.	2016-06-23 14:01:54 -07:00
front-end-build-process.md	Remove rST files to replace with Markdown.	2016-05-31 10:55:49 -07:00
html_unescape.py	Change shebangs from python2.7 to python.	2016-05-29 05:03:08 -07:00
index.rst	Add architectural overview documentation.	2016-06-03 11:54:02 -07:00
integration-guide.md	Remove rST files to replace with Markdown.	2016-05-31 10:55:49 -07:00
logging.md	Improve first-time contributor docs.	2016-05-31 07:47:45 -07:00
markdown.md	Docs: Fix typos in docs.	2016-06-02 10:31:41 -07:00
mypy.md	Add documentation about zerver/lib/str_utils.py.	2016-06-11 17:31:56 +05:30
new-feature-tutorial.md	Docs: Fix typos in docs.	2016-06-02 10:31:41 -07:00
queuing.md	Add documentation on the Zulip RabbitMQ queues.	2016-04-01 09:56:59 -07:00
readme-symlink.md	Rearrange docs table of contents for coherence.	2016-05-31 09:07:09 -07:00
requirements.readthedocs.txt	Move doc building dependencies to requirements/docs.txt.	2016-06-20 16:05:42 -07:00
roadmap.md	roadmap: Add strikethrough for completed projects.	2016-06-21 17:30:33 -07:00
schema-migrations.md	Add some docs on schema migrations.	2016-04-01 09:57:00 -07:00
settings.md	Make minor edits to new settings documentation.	2016-06-17 12:15:15 -07:00
testing.md	Remove references to requirements.txt.	2016-06-21 07:48:24 -07:00
translating.md	Add documentation for json_error and JsonableError.	2016-06-04 18:48:32 -07:00

README.md

These docs are written in Commonmark Markdown with a small bit of rST. We've chosen Markdown because it is easy to write. The docs are served in production at zulip.readthedocs.io.

If you want to build the documentation locally (e.g. to test your changes), the dependencies are automatically installed as part of Zulip development environment provisioning, and you can build the documentation using:

cd docs/
make html

You can also usually test your changes by pushing a branch to GitHub and looking at the content on the GitHub web UI, since GitHub renders Markdown.

When editing dependencies for the Zulip documentation, you should edit requirements/docs.txt (which is used by ReadTheDocs to build the documentation quickly, without installing all of Zulip's dependencies).