paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-30 19:43:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

help-docs: Move help center documentation to top level directory.

Browse Source 
These files are not Jinja2 templates, so there's no reason that they needed
to be inside `templates/zerver`. Moving them to the top level reflects their
importance and also makes it feel nicer to work on editing the help center content, 
without it being unnecessary buried deep in the codebase.
This commit is contained in:
Lauryn Menard
2023-01-25 23:08:29 +01:00
committed by GitHub
parent 6cf1d9fa20
commit dedea23745
269 changed files with 40 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/tutorials/new-feature-tutorial.md
View File

@@ -68,7 +68,7 @@ organization in Zulip). The following files are involved in the process:
- `zerver/openapi/zulip.yaml`: OpenAPI definitions for the Zulip REST API.
- `templates/zerver/api/changelog.md`: documentation listing all changes to the Zulip Server API.
- `templates/zerver/help/...`: end user facing documentation (Help Center) for the application.
- `help/...`: end user facing documentation (Help Center) for the application.
### Adding a field to the database
@@ -157,10 +157,10 @@ For detailed information on the kinds of documentation Zulip has, see
[Documentation](../documentation/overview.md).
**Help center documentation:** You will likely need to at least update,
extend and link to `/help/` articles that are related to your new
feature. [Writing help center articles](../documentation/helpcenter.md)
extend and link to articles in the `help/` directory that are related
to your new feature. [Writing help center articles](../documentation/helpcenter.md)
provides more detailed information about writing and editing feature
`/help/` articles.
`help/` directory articles.
**API documentation:** A new feature will probably impact the REST API
documentation as well, which will mean updating `zerver/openapi/zulip.yaml`
@@ -696,10 +696,10 @@ this feature would be to update and/or augment Zulip's existing
changes and additions.
At the very least, this will involve modifying (or adding) a Markdown
file documenting the feature to `templates/zerver/help/` in the main
Zulip server repository, where the source for Zulip's end user
documentation is stored. Details about writing, editing and testing
these Markdown files can be found in:
file documenting the feature in the `help/` directory of the main Zulip
server repository, where the source for Zulip's end user documentation
is stored. Details about writing, editing and testing these Markdown
files can be found in:
[Writing help center articles](../documentation/helpcenter.md).
Also, new features will often impact Zulip's REST API documentation,