mirror of
https://github.com/zulip/zulip.git
synced 2026-07-18 21:04:19 +08:00
5cac44be06
We should rearrange Zulip's developer docs to make it easier to find the documentation that new contributors need. Name changes Rename "Code contribution guide" section -> "Contributing to Zulip". Rename "Contributing to Zulip" page -> "Contributing guide". Organizational changes to the newly-named "Contributing to Zulip": Move up "Contributing to Zulip", as the third link in sidebar index. Move up renamed "Contributing guide" page to the top of this section. Move up "Zulip code of Conduct", as the second link of this section. Move down "Licensing", as the last link of this section. Move "Accessibility" just below "HTML and CSS" in Subsystems section. Update all links according to the changes above. Redirects should be added as needed. Fixes: #22517.
139 lines
2.3 KiB
Markdown
139 lines
2.3 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
|
|
|
|
Index <https://zulip.readthedocs.io/en/latest/>
|
|
```
|