forked from zulip/zulip
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rearrange docs table of contents for coherence.
The order and structure of the Read The Docs documentation was fairly arbitrary; here's a suggestion for how to change its information architecture so it's more useful to a new contributor. This adds a short Zulip overview, and a table of contents and code contribution intro for new contributors. Fixes: zulip#668. Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
- Loading branch information
Showing
3 changed files
with
42 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
======================= | ||
Code contribution guide | ||
======================= | ||
|
||
Thanks for contributing to Zulip! We hope this guide helps make the | ||
process smooth sailing for you. | ||
|
||
The "Ways to Contribute" and "How to get involved" sections of | ||
:doc:`readme-symlink` are a good place to start! After that, check out | ||
the tips below. | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
code-style | ||
markdown | ||
testing | ||
logging | ||
mypy | ||
front-end-build-process | ||
queuing | ||
schema-migrations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../README.md |