docs: github action directory name error and add prompt (#949)

Co-authored-by: Divyansh Singh <[email protected]>
vuejs · Jul 8, 2022 · 0dafee7 · 0dafee7
1 parent 1daeaa1
commit 0dafee7
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/docs/guide/deploying.md b/docs/guide/deploying.md
@@ -65,7 +65,7 @@ Don't enable options like _Auto Minify_ for HTML code. It will remove comments f
 
 ### Using GitHub Actions
 
-1. Create a file named `deploy.yml` inside `.github/workflow` directory of your project with the following content:
+1. Create a file named `deploy.yml` inside `.github/workflows` directory of your project with the following content:
 
    ```yaml
    name: Deploy
@@ -96,6 +96,10 @@ Don't enable options like _Auto Minify_ for HTML code. It will remove comments f
              publish_dir: docs/.vitepress/dist
    ```
 
+   ::: tip
+   Please replace the corresponding branch name. For example, if the branch you want to build is `master`, then you should replace `main` with `master` in the above file.
+   :::
+
 2. Now commit your code and push it to the `main` branch.
 
 3. Wait for actions to complete. Then select `gh-pages` branch as GitHub Pages source in your repository settings. Now your docs will automatically deploy each time you push.