paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-01 12:33:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Update tutorial for writing help center documentation.

Browse Source 
Updates the tutorial for writing help center articles to encourage
contributors to add to or enhance the existing help center docs
before writing a new articles for new features.

Also, generally updates references to 'user documentation' to be
'help center documentation'.

Additionally, updates some headers within the tutorials for clarity
and consistency, and adds some linkifying throughout the section on
writing documentation.
This commit is contained in:
Lauryn Menard
2021-12-17 15:59:58 +01:00
committed by Tim Abbott
parent 048c9b99e3
commit 784f923dda
7 changed files with 122 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/testing/testing.md
View File

@@ -66,7 +66,7 @@ Additionally, Zulip also has about a dozen smaller tests suites:
- `tools/test-documentation`: Checks for broken links in this
ReadTheDocs documentation site.
- `tools/test-help-documentation`: Checks for broken links in the
`/help` user documentation site, and related pages.
`/help/` help center documentation, and related pages.
- `tools/test-api`: Tests that the API documentation at `/api`
actually works; the actual code for this is defined in
`zerver/openapi/python_examples.py`.