mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 05:53:43 +00:00
157 lines
2.7 KiB
Markdown
157 lines
2.7 KiB
Markdown
# Zulip documentation overview
|
|
|
|
Welcome! This is the documentation site for running [Zulip organized team
|
|
chat](https://zulip.com) in production, contributing to the [Zulip open-source
|
|
project](https://github.com/zulip), and generally learning how Zulip works under
|
|
the hood.
|
|
|
|
The following pages may help you get started:
|
|
|
|
- [Installation instructions](production/install.md) for setting up your Zulip
|
|
server.
|
|
- [Contributing guide](contributing/contributing.md), with step-by-step
|
|
instructions on how to get started contributing code to Zulip.
|
|
|
|
You may also want to check out:
|
|
|
|
- [An overview](https://zulip.com/features/) of the features available in Zulip.
|
|
- [Help center documentation](https://zulip.com/help/) for users and
|
|
administrators of Zulip organizations.
|
|
- [API documentation](https://zulip.com/api/) for writing integrations or bots
|
|
using the Zulip API.
|
|
|
|
If there's any information you can't find, please drop by the
|
|
[#documentation](https://chat.zulip.org/#narrow/channel/19-documentation)
|
|
channel in the [Zulip development
|
|
community](https://zulip.com/development-community/) and let us know! We work
|
|
hard to make Zulip's documentation comprehensive and easy to follow.
|
|
|
|
The documentation here is organized into the following sections:
|
|
|
|
- {ref}`Overview <overview>`
|
|
- {ref}`Zulip in production <zulip-in-production>`
|
|
- {ref}`Contributing to Zulip <contributing-to-zulip>`
|
|
- {ref}`Development environment <development-environment>`
|
|
- {ref}`Developer tutorials <developer-tutorials>`
|
|
- {ref}`Git guide <git-guide>`
|
|
- {ref}`Code testing <code-testing>`
|
|
- {ref}`Subsystem documentation <subsystem-documentation>`
|
|
- {ref}`Writing documentation <writing-documentation>`
|
|
- {ref}`Translating Zulip <translating>`
|
|
- {ref}`Outreach programs <outreach>`
|
|
|
|
## Documentation index
|
|
|
|
(overview)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
Zulip homepage <https://zulip.com/>
|
|
overview/index
|
|
```
|
|
|
|
(zulip-in-production)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
production/index
|
|
```
|
|
|
|
(contributing-to-zulip)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
contributing/index
|
|
```
|
|
|
|
(development-environment)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
development/index
|
|
```
|
|
|
|
(developer-tutorials)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
tutorials/index
|
|
```
|
|
|
|
(git-guide)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
git/index
|
|
```
|
|
|
|
(code-testing)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
testing/index
|
|
```
|
|
|
|
(subsystem-documentation)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
subsystems/index
|
|
```
|
|
|
|
(writing-documentation)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
documentation/index
|
|
```
|
|
|
|
(translating)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
translating/index
|
|
```
|
|
|
|
(outreach)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
outreach/index
|
|
|
|
Index <https://zulip.readthedocs.io/en/latest/>
|
|
```
|