History

Tim Abbott 4c8a0340ef Update requirements docs with LetsEncrypt mention.		2016-07-12 22:15:01 -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	docs: Add link to documentation building docs.	2016-06-26 10:04:07 -07:00
architecture-overview.md	Move prod maintenance guide to new page.	2016-07-12 15:46:10 -07:00
changelog.md	lint: Add documentation lint check for JavaScript spelling.	2016-07-12 19:22:21 -07:00
code-style.md	lint: Add documentation lint check for JavaScript spelling.	2016-07-12 19:22:21 -07:00
conf.py	docs: Don't require typing module to be installed.	2016-06-26 10:10:59 -07:00
directory-structure.md	lint: Add documentation lint check for JavaScript spelling.	2016-07-12 19:22:21 -07:00
front-end-build-process.md	Update documentaton to reflect Django-Pipeline==1.6.8.	2016-07-09 07:09:55 -07:00
full-text-search.md	docs: Add some full-text search documentation.	2016-06-26 09:32:54 -07:00
html_css.md	Fix misspelling in HTML CSS documentation.	2016-07-12 14:15:23 -04:00
html_unescape.py	Change shebangs from python2.7 to python.	2016-05-29 05:03:08 -07:00
index.rst	docs: Turn SSO auth documentation into general auth page.	2016-07-12 16:19:13 -07:00
integration-guide.md	docs: Improve several headings.	2016-06-26 09:54:19 -07:00
logging.md	Improve first-time contributor docs.	2016-05-31 07:47:45 -07:00
markdown.md	docs: Improve several headings.	2016-06-26 09:54:19 -07:00
mypy.md	Fix formatting, capitalization, & grammar in mypy doc.	2016-07-12 19:14:31 -07:00
new-feature-tutorial.md	docs: Fix new feature tutorial link to testing docs.	2016-06-27 20:52:20 -07:00
prod-auth-first-login.md	Move production health check doc to separate page.	2016-07-12 15:46:10 -07:00
prod-authentication-methods.md	docs: Turn SSO auth documentation into general auth page.	2016-07-12 16:19:13 -07:00
prod-customize.md	Move prod maintenance guide to new page.	2016-07-12 15:46:10 -07:00
prod-health-check-debug.md	Move prod customization guide to new page.	2016-07-12 15:46:10 -07:00
prod-install.md	docs: Document the fact that installer is idempotent.	2016-07-12 18:26:44 -07:00
prod-maintain-secure-upgrade.md	Move prod remote user SSO auth guide to new page.	2016-07-12 15:46:10 -07:00
prod-postgres.md	Move prod postgres details to separate page.	2016-07-12 15:46:10 -07:00
prod-requirements.md	Update requirements docs with LetsEncrypt mention.	2016-07-12 22:15:01 -07:00
queuing.md	Update documentation on development auto-reloading.	2016-06-26 20:20:13 -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	lint: Add documentation lint check for JavaScript spelling.	2016-07-12 19:22:21 -07:00
schema-migrations.md	docs: Fix hardcoding of links to zulip.readthedocs.io.	2016-06-27 20:54:21 -07:00
settings.md	docs: Fix hardcoding of links to zulip.readthedocs.io.	2016-06-27 20:54:21 -07:00
testing.md	Fix formatting & capitalization in testing doc.	2016-07-12 19:14:31 -07:00
translating.md	Add documentation to announce default language setting.	2016-07-04 11:56:24 -07:00
version-control.md	docs: Split out version control guidelines.	2016-06-26 10:04:06 -07:00

README.md

Documentation

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

and then opening file:///path/to/zulip/_build/html/index.html in your browser (you can also use e.g. firefox docs/_build/html/index.html from the root of your Zulip checkout).

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