From 2f2e3cd99d40a2c49837e6801ca33d3a377ba14c Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Wed, 15 Apr 2020 02:38:55 +0800 Subject: [PATCH] docs(v2): fix doc changes in #2606 --- website/docs/cli.md | 2 +- website/docs/versioning.md | 8 ++++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/website/docs/cli.md b/website/docs/cli.md index 8d33c677ec..36c8f9a283 100644 --- a/website/docs/cli.md +++ b/website/docs/cli.md @@ -51,7 +51,7 @@ Builds and serves a preview of your site locally with [Webpack Dev Server](https :::important -Please note that some functionality (for example, anchor links) will not work in development. Don't freak out though, the functionality will work as expected in production. +Please note that some functionality (for example, anchor links) will not work in development. The functionality will work as expected in production. ::: diff --git a/website/docs/versioning.md b/website/docs/versioning.md index 0fc39c872b..9bb5ca92b9 100644 --- a/website/docs/versioning.md +++ b/website/docs/versioning.md @@ -5,9 +5,13 @@ title: Versioning You can use the version script to create a new documentation version based on the latest content in the `docs` directory. That specific set of documentation will then be preserved and accessible even as the documentation in the `docs` directory changes moving forward. -:::caution Think about it before starting to version your documentation - it can become difficult for contributors to help improve it! ::: +:::caution -Most of the time, you don't need versioning as it will just increase your build time, and introduce complexity to your codebase. Versioning is **best suited for website with high-traffic and rapid changes to documentation between versions**. If your documentation rarely changes, don't add versioning to your documentation. +Think about it before starting to version your documentation - it can become difficult for contributors to help improve it! + +::: + +Most of the time, you don't need versioning as it will just increase your build time, and introduce complexity to your codebase. Versioning is **best suited for websites with high-traffic and rapid changes to documentation between versions**. If your documentation rarely changes, don't add versioning to your documentation. To better understand how versioning works and see if it suits your needs, you can read on below.