Files
upstream-zulip/docs/index.md
upstream-mirror 64898b2c79
Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)
2026-09-15 15:05:30 +05:00

178 lines
2.9 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}`Incoming webhook integrations <webhook-integrations>`
- {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
```
(webhook-integrations)=
```{toctree}
---
maxdepth: 3
---
webhooks/index
```
(contributing-to-zulip)=
```{toctree}
---
maxdepth: 3
---
contributing/index
```
(project-processes)=
```{toctree}
---
maxdepth: 3
---
processes/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/>
```