mirror of
https://github.com/zulip/zulip.git
synced 2025-10-29 19:13:53 +00:00
7072fa5b37
This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
23 lines
776 B
Markdown
23 lines
776 B
Markdown
# Bug report guidelines
|
|
|
|
Please include these elements in your bug report to make it easier for us to help you.
|
|
|
|
* A brief title
|
|
|
|
* An explanation of what you were expecting vs. the actual result
|
|
|
|
* Steps to take in order to reproduce the buggy behavior
|
|
|
|
* Whether you are using Zulip in production or in the development
|
|
environment, and whether these are old versions
|
|
|
|
* Whether you are using the web app, a desktop app or a mobile device
|
|
to access Zulip
|
|
|
|
* Any additional information that would help: screenshots, GIFs, a
|
|
pastebin of the error log
|
|
|
|
Further reading:
|
|
* [How to write a bug report that will make your engineers love you](https://testlio.com/blog/the-ideal-bug-report/)
|
|
* [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html)
|