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: #668.

Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
This commit is contained in:
Sumana Harihareswara 2016-05-14 12:50:19 -04:00 committed by Tim Abbott
parent 3029b3681f
commit e0bc57ddb1
3 changed files with 42 additions and 9 deletions

View File

@ -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

View File

@ -6,22 +6,31 @@
Welcome to Zulip documentation! Welcome to Zulip documentation!
=============================== ===============================
Zulip is a powerful, open source group chat application. Written in
Python and using the Django framework, Zulip supports both private
messaging and group chats via conversation streams.
Zulip also supports fast search, drag-and-drop file uploads, image
previews, group private messages, audible notifications, missed-message
emails, desktop apps, and much more.
Further information on the Zulip project and its features can be found
at `https://www.zulip.org <https://www.zulip.org>`__ and in these
docs. Our code is available at `our GitHub repository
<https://github.com/zulip/>`__.
This set of documents covers installation and contribution instructions.
Contents: Contents:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 3
readme-symlink
integration-guide integration-guide
new-feature-tutorial new-feature-tutorial
code-contribution-checklist
directory-structure directory-structure
code-style
testing
logging
markdown
queuing
schema-migrations
front-end-build-process
mypy
translating translating
changelog changelog
roadmap roadmap

1
docs/readme-symlink.md Symbolic link
View File

@ -0,0 +1 @@
../README.md