zulip

Commit Graph

Author	SHA1	Message	Date
David Rosa	ed409e8071	docs: Explain commit summary example explicitly. Adds an explicit explanation to help contributors avoid common mistakes like capitalization errors, missing trailing periods, and incorrectly prefixing the name of a subsystem. Fixes #1535.	2019-12-06 11:39:40 -08:00
Chris Bobbe	04e6c3bd18	docs/version-control: Set commit message line limit to 70. https://github.com/zulip/zulip-mobile/pull/3404#issuecomment-477411875 A discussion followed at https://chat.zulip.org/#narrow/stream/3-backend/topic/commit.20line.20length and that was agreed on for the commit message body, but noted that a length of 76 was acceptable for the summary because of the single-line constraint and the fact that it ends in a period, making it clear where it ends.	2019-09-16 15:02:02 -07:00
Anders Kaseorg	c6da0d13cd	docs: Update links to skip help.github.com redirects. help.github.com seems to have a bug where HEAD on a redirected page returns 404. This causes tools/test-documentation to fail. Fix it by skipping the redirects. Signed-off-by: Anders Kaseorg <andersk@mit.edu>	2019-02-26 11:03:08 -08:00
David Rosa Tamsen	7072fa5b37	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-16 09:45:08 -08:00

4 Commits