mirror of https://github.com/zulip/zulip.git
100 lines
2.4 KiB
ReStructuredText
100 lines
2.4 KiB
ReStructuredText
.. zulip documentation master file, created by
|
|
sphinx-quickstart on Mon Aug 17 16:24:04 2015.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to the Zulip documentation!
|
|
===================================
|
|
|
|
Welcome! Zulip's documentation is split into four parts:
|
|
|
|
- `User documentation <https://zulipchat.com/help>`__, for users and
|
|
administrators of Zulip organizations.
|
|
- `Installation documentation <production/overview.html>`__, for
|
|
installing and maintaining a self-hosted Zulip installation.
|
|
- `API documentation <https://zulipchat.com/api/>`__, for writing
|
|
integrations or bots using the Zulip API.
|
|
- `Contributor documentation <overview/contributing.html>`__, for
|
|
developing the Zulip software, translating, submitting bug reports,
|
|
or making other contributions to the project.
|
|
|
|
Zulip has well over 150,000 words of documentation. If you can't find
|
|
what you're looking for, please `let us know
|
|
<contributing/chat-zulip-org.html>`__! Further information on the
|
|
Zulip project and its features can be found at `https://www.zulip.org
|
|
<https://www.zulip.org>`__.
|
|
|
|
This site contains our installation and contributor documentation. If
|
|
this is your first time here, you may want to start with `Production
|
|
overview <production/overview.html>`_ or `Contributing to Zulip
|
|
<overview/contributing.html>`_.
|
|
|
|
Contents:
|
|
|
|
* :ref:`Overview <overview>`
|
|
* :ref:`Zulip in Production <zulip-in-production>`
|
|
* :ref:`Development Environment <development-environment>`
|
|
* :ref:`Developer Tutorials <developer-tutorials>`
|
|
* :ref:`Code Contribution Guide <code-contribution-guide>`
|
|
* :ref:`Code Testing <code-testing>`
|
|
* :ref:`Subsystem Documentation <subsystem-documentation>`
|
|
* :ref:`Translating <translating>`
|
|
|
|
.. _overview:
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
overview/index
|
|
|
|
.. _zulip-in-production:
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
production/index
|
|
|
|
.. _development-environment:
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
development/index
|
|
|
|
.. _developer-tutorials:
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
tutorials/index
|
|
|
|
.. _code-contribution-guide:
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
contributing/index
|
|
|
|
.. _code-testing:
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
testing/index
|
|
|
|
.. _subsystem-documentation:
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
subsystems/index
|
|
|
|
.. _translating:
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
translating/index
|
|
|
|
Index <https://zulip.readthedocs.io/en/latest/>
|