From c4eede68d6843caca4ac6abdf90067bead58987e Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Thu, 20 Jan 2022 19:49:27 +0100 Subject: [PATCH] docs: Rename `user.md` to `helpcenter.md`. Renames `/docs/documentation/user.md` to reflect the rebranding from "user documentation" to "help center documentation". Also, fixes any linking in the docs to that file. --- docs/documentation/api.md | 2 +- docs/documentation/{user.md => helpcenter.md} | 0 docs/documentation/index.md | 2 +- docs/documentation/overview.md | 2 +- docs/tutorials/new-feature-tutorial.md | 4 ++-- 5 files changed, 5 insertions(+), 5 deletions(-) rename docs/documentation/{user.md => helpcenter.md} (100%) diff --git a/docs/documentation/api.md b/docs/documentation/api.md index 72147d0b82..599d077596 100644 --- a/docs/documentation/api.md +++ b/docs/documentation/api.md @@ -30,7 +30,7 @@ Our API documentation is defined by a few sets of files: [OpenAPI description](../documentation/openapi.md) at `zerver/openapi/zulip.yaml`. - The documentation is written the same Markdown framework that powers - our [user docs](../documentation/user.md), with some special + our [help center docs](../documentation/helpcenter.md), with some special extensions for rendering nice code blocks and example responses. Most API endpoints share a common template, `templates/zerver/api/api-doc-template.md`, which renders the diff --git a/docs/documentation/user.md b/docs/documentation/helpcenter.md similarity index 100% rename from docs/documentation/user.md rename to docs/documentation/helpcenter.md diff --git a/docs/documentation/index.md b/docs/documentation/index.md index f48e88f5b4..268e65c4ee 100644 --- a/docs/documentation/index.md +++ b/docs/documentation/index.md @@ -6,7 +6,7 @@ maxdepth: 3 --- overview -user +helpcenter integrations api openapi diff --git a/docs/documentation/overview.md b/docs/documentation/overview.md index fe12468a4c..685c5b35b6 100644 --- a/docs/documentation/overview.md +++ b/docs/documentation/overview.md @@ -103,7 +103,7 @@ designed to explain how the product works to end users. We aim for this to be clear, concise, correct, and readable to nontechnical audiences where possible. -See our guide on [writing help center articles](user.md). +See our guide on [writing help center articles](helpcenter.md). ### Integrations documentation diff --git a/docs/tutorials/new-feature-tutorial.md b/docs/tutorials/new-feature-tutorial.md index 537bcc71d6..cf0d300900 100644 --- a/docs/tutorials/new-feature-tutorial.md +++ b/docs/tutorials/new-feature-tutorial.md @@ -158,7 +158,7 @@ For detailed information on the kinds of documentation Zulip has, see **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/user.md) +feature. [Writing help center articles](../documentation/helpcenter.md) provides more detailed information about writing and editing feature `/help/` articles. @@ -695,7 +695,7 @@ 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: -[Writing help center articles](../documentation/user.md). +[Writing help center articles](../documentation/helpcenter.md). Also, new features will often impact Zulip's REST API documentation, which is found in `zerver/openapi/zulip.yaml`. You may have noticed