Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/docs/subsystems/index.rst

49 lines
738 B
ReStructuredText
Raw Normal View History

docs: Reorganize developer docs to improve navigation. 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.
2017-11-08 17:55:36 +01:00
########################
Subsystems Documentation
########################
.. toctree::
:maxdepth: 3
dependencies
settings
events-system
queuing
custom-apps
pointer
markdown
docs: Add subsystem documentation for caching.
2018-07-31 23:07:42 +02:00
caching
docs: Reorganize developer docs to improve navigation. 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.
2017-11-08 17:55:36 +01:00
realms
management-commands
front-end-build-process
schema-migrations
docs: Move migration-renumbering.md to subsystems/. It belongs in that part of the documentation. We also update the links in docs/subsystems/schema-migrations.md.
2017-11-18 12:37:29 +01:00
migration-renumbering
docs: Reorganize developer docs to improve navigation. 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.
2017-11-08 17:55:36 +01:00
html_css
hashchange-system
emoji
hotspots
full-text-search
docs: Rename docs/subsystems/oauth.md to auth.md.
2018-08-18 02:40:53 +02:00
auth
docs: Reorganize developer docs to improve navigation. 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.
2017-11-08 17:55:36 +01:00
email
analytics
html-templates
client
logging
typing-indicators
docs: Move users.md to subsystems/ and give it a title. Edited by tabbott to improve the users.md title and update the TOC in this commit.
2017-11-18 12:44:27 +01:00
users
docs: Add a basic guide on the current guest users implementation. This will likely change pretty quickly as we build this feature; I wrote this just to have a central place to keep track of what we'll need to document when we ship this feature.
2018-05-04 18:55:17 +02:00
guest-users
docs: Add a document with notes on the Django upgrade process.
2018-11-15 02:47:40 +01:00
django-upgrades
docs: Reorganize developer docs to improve navigation. 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.
2017-11-08 17:55:36 +01:00
release-checklist
api-release-checklist
docs: Rename Swagger to OpenAPI in the dev docs' titles.
2018-05-15 20:54:48 +02:00
openapi-api-docs
docs: Add a few more articles to subsystems TOC. These are subsystems documentation, which was accidentally not listed in the TOC.
2017-11-18 12:58:01 +01:00
conversion
input-pills
docs: Add some basic subsystem documentation for thumbnailing.
2018-07-30 22:16:26 +02:00
thumbnailing
docs: Add an initial document explaining our presence protocol.
2018-04-13 02:04:51 +02:00
presence
docs: Add a few more articles to subsystems TOC. These are subsystems documentation, which was accidentally not listed in the TOC.
2017-11-18 12:58:01 +01:00
unread_messages
billing: Update billing system.
2018-03-31 04:13:44 +02:00
billing
docs: Move subsystems/documentation to be closer to other docs articles.
2018-10-10 00:08:33 +02:00
documentation
docs: Reorganize developer docs to improve navigation. 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.
2017-11-08 17:55:36 +01:00
user-docs
api docs: Move integration-docs-guide to docs/.
2018-10-10 00:21:18 +02:00
integration-docs
Add docs for widgets subsystem.
2018-08-09 01:08:59 +02:00
widgets