diff --git a/docs/code-contribution-checklist.rst b/docs/code-contribution-checklist.rst new file mode 100644 index 0000000000000..3eb7590f11a5b --- /dev/null +++ b/docs/code-contribution-checklist.rst @@ -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 diff --git a/docs/index.rst b/docs/index.rst index 1911beb850080..61e324960e06e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,22 +6,31 @@ 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 `__ and in these +docs. Our code is available at `our GitHub repository +`__. + +This set of documents covers installation and contribution instructions. + Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 3 + readme-symlink integration-guide new-feature-tutorial + code-contribution-checklist directory-structure - code-style - testing - logging - markdown - queuing - schema-migrations - front-end-build-process - mypy translating changelog roadmap diff --git a/docs/readme-symlink.md b/docs/readme-symlink.md new file mode 120000 index 0000000000000..32d46ee883b58 --- /dev/null +++ b/docs/readme-symlink.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file