b0ce4f1bce
docs: Fix many spelling mistakes.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-07 18:51:06 -08:00
6cd8e088e9
doc: Fix typo in zulipbot-usage doc.
...
Fix a spelling mistake in the zulipbot doc.
2022-01-11 15:40:06 -08:00
a4dbc1edd4
docs: Format Markdown with Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-08 12:06:24 -07:00
35c1c8d41b
docs: Apply sentence single-spacing from Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-08 12:06:24 -07:00
915884bff7
docs: Apply bullet style changes from Prettier.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-08 12:06:24 -07:00
1ce12191aa
docs: Update links for other repository branch renames.
...
GitHub redirects these, but we should use the canonical URLs.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-31 15:28:01 -07:00
0a3e022376
docs: Adjust list item indentation for Prettier compatibility.
...
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 23:14:37 -07:00
16d41e59b5
doc: Update documentation replacing travis with CircleCI.
2020-04-28 11:24:54 -07:00
0d52d24d64
docs: pip upgrade recommonmark and CommonMark
...
Summary:
- recommonmark: 0.4.0 -> 0.5.0
- CommonMark: 0.5.4 -> 0.9.0
- Fixed links getting their .md file extension cut off
- Supressed 262 new warnings
Details:
Appended #anchors to markdown github links as a workaround to
recommonmark 0.5.0 cutting off the ".md" part from them.
Sphinx build would fail as follows
[documentation_crawler] ERROR: Please check link:
<404 https://github.com/zulip/zulipbot/blob/master/.github/CONTRIBUTING >
<404 https://github.com/zulip/zulip/blob/master/requirements/README >
<404 https://github.com/zulip/python-zulip-api/blob/master/zulip_bots/README >
sphinx build would also log a "WARNING: None:any reference target not found"
for every link ending in .html
So a good temporary solution is to suppress all warnings with the method suggested here:
https://stackoverflow.com/questions/37359407/suppress-warnings-for-unfound-references-with-default-role-any-in-sphinx
A better solution would be to edit all links ending .html and use .md instead;
which would also solve PR #11719 .
Fixes #11395 .
2019-08-15 22:41:40 -07:00
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
58e28fbd21
developer docs: Refer to 'zulipbot add' instead of 'zulipbot label'.
...
These changes are consistent with naming in zulip/zulipbot. See:
- https://github.com/zulip/zulipbot/commit/e29e7eb
- https://github.com/zulip/zulipbot/wiki/Commands#username-add-label-name
2018-09-21 12:16:39 -07:00
baffcf0948
Fix: broken link zulip/zulipbot
2018-03-05 10:51:56 -08:00
46ba76e245
Fix broken link to GitHub CONTRIBUTING guide.
2017-11-19 20:31:27 -08:00
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
Anders Kaseorg
Rishabh-792
arpit551
David Rosa
Anders Kaseorg
Jack Zhang
Shivam Gera
Tim Abbott