mirror of
https://github.com/zulip/zulip.git
synced 2025-11-06 15:03:34 +00:00
1089a34c86
* Make an "Outreach programs" documentation directory. * Revamp doc on having an amazing outreach program experience. * Extract an outreach programs overview page from GSoC guide. * Add a guide on making PRs easy to review, extracted from "How to have an amazing summer with Zulip". * Create a guide for mentors, extracted from "How to have an amazing summer with Zulip". * Add a guide on how to ask great questions extracted from GSoC guide. * Extract general page on applying to outreach programs from GSoC guide. * Simplify GSoC guide page to just describe project ideas. * Many local edits to the reorganized content.
149 lines
2.4 KiB
Markdown
149 lines
2.4 KiB
Markdown
# Welcome to the Zulip documentation!
|
|
|
|
Welcome! Zulip's documentation is split into four parts:
|
|
|
|
- [Help center documentation](https://zulip.com/help), for users and
|
|
administrators of Zulip organizations.
|
|
- [Installation documentation](production/install.md), for
|
|
installing and maintaining a production self-hosted Zulip installation.
|
|
- [API documentation](https://zulip.com/api/), for writing
|
|
integrations or bots using the Zulip API.
|
|
- [Contributor documentation](contributing/contributing.md), 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](https://zulip.com/development-community/)! Further information on
|
|
the Zulip project and its features can be found at
|
|
<https://zulip.com>.
|
|
|
|
This site contains our installation and contributor documentation. If
|
|
this is your first time here, you may want to start with [Production
|
|
installation](production/install.md) or [Contributing guide](contributing/contributing.md).
|
|
|
|
Contents:
|
|
|
|
- {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 <translating>`
|
|
|
|
(overview)=
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 3
|
|
---
|
|
|
|
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/>
|
|
```
|