From 0a74654ee5fef14155c6aaac8b4b4d8771f2c3b1 Mon Sep 17 00:00:00 2001
From: leejooy96 <leejooy96@gmail.com>
Date: Tue, 1 Nov 2022 10:22:41 +0900
Subject: [PATCH] docs: update and fix typo in some documents

---
 ...{getting-started.md => 1-getting-started.md} |  3 ---
 ...onfiguration.md => 2-build-configuration.md} |  0
 docs/install-local-documentation.md             | 17 +++++++++++++++++
 docs/other-projects.md                          |  2 +-
 docs/pre-configured-components.md               |  2 +-
 5 files changed, 19 insertions(+), 5 deletions(-)
 rename docs/{getting-started.md => 1-getting-started.md} (92%)
 rename docs/{build-configuration.md => 2-build-configuration.md} (100%)
 create mode 100644 docs/install-local-documentation.md

diff --git a/docs/getting-started.md b/docs/1-getting-started.md
similarity index 92%
rename from docs/getting-started.md
rename to docs/1-getting-started.md
index d7623e1..3ed291c 100644
--- a/docs/getting-started.md
+++ b/docs/1-getting-started.md
@@ -29,9 +29,6 @@ $ yarn install
 
 # via pnpm (https://pnpm.io)
 $ pnpm i
-
-# via cnpm (https://github.com/cnpm/cnpm)
-$ cnpm i
 ```
 
 ## Run in development environment
diff --git a/docs/build-configuration.md b/docs/2-build-configuration.md
similarity index 100%
rename from docs/build-configuration.md
rename to docs/2-build-configuration.md
diff --git a/docs/install-local-documentation.md b/docs/install-local-documentation.md
new file mode 100644
index 0000000..3880832
--- /dev/null
+++ b/docs/install-local-documentation.md
@@ -0,0 +1,17 @@
+# Manage local documentation
+
+Documents from Vutron can be viewed in the local environment through the VitePress viewer.
+
+Since VitePress and related plugin packages are configured to be selectively installed, they cannot be installed with `npm i`.
+
+Install the relevant packages using the following preconfigured script commands:
+
+```shell
+$ npm run docs:install
+```
+
+You can run the local server where the documents are hosted via the command below.
+
+```shell
+$ npm run docs:dev
+```
diff --git a/docs/other-projects.md b/docs/other-projects.md
index 8ba50b7..b1d5325 100644
--- a/docs/other-projects.md
+++ b/docs/other-projects.md
@@ -1,4 +1,4 @@
-# Other projects
+# Other Projects
 
 ## Looking for Electron templates made with React?
 
diff --git a/docs/pre-configured-components.md b/docs/pre-configured-components.md
index d727838..59fb7dd 100644
--- a/docs/pre-configured-components.md
+++ b/docs/pre-configured-components.md
@@ -1,4 +1,4 @@
-# Pre-configured components
+# Pre-configured Components
 
 - [Vite 3.x.x](https://vitejs.dev)
 - [Electron 21.x.x](https://www.electronjs.org)