From 7b43a83c4023048800351625f5b60695b7c69dd6 Mon Sep 17 00:00:00 2001
From: Cotes Chung <11371340+cotes2020@users.noreply.github.com>
Date: Sat, 19 Aug 2023 12:51:22 +0800
Subject: [PATCH] refactor: move project files to `docs` folder

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 2 +-
 .github/ISSUE_TEMPLATE/feature_request.md | 3 +--
 .github/workflows/ci.yml                  | 1 +
 README.md                                 | 2 +-
 _config.yml                               | 1 +
 {.github => docs}/CODE_OF_CONDUCT.md      | 0
 {.github => docs}/CONTRIBUTING.md         | 4 ++--
 {.github => docs}/SECURITY.md             | 0
 8 files changed, 7 insertions(+), 6 deletions(-)
 rename {.github => docs}/CODE_OF_CONDUCT.md (100%)
 rename {.github => docs}/CONTRIBUTING.md (98%)
 rename {.github => docs}/SECURITY.md (100%)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index f057a1e..2eb21a1 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -3,7 +3,7 @@ name: Bug Report
 about: Create a report to help us improve
 ---
 
-> **Tips**: Remember, contributions to this repository should follow the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md).
+> **Tips**: Remember, contributions to this repository should follow the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md).
 
 ## Describe the bug
 
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index c1a91f7..2a8d6d6 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,8 +4,7 @@ about: Suggest an idea for this project
 labels: enhancement
 ---
 
-> **Tips**: Remember, contributions to this repository should follow the
-[contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md).
+> **Tips**: Remember, contributions to this repository should follow the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md).
 
 ## Is your feature request related to a problem? Please describe
 
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index b51c183..38dbb80 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -8,6 +8,7 @@ on:
       - ".github/**"
       - "!.github/workflows/ci.yml"
       - ".gitignore"
+      - "docs/**"
       - "README.md"
       - "LICENSE"
   pull_request:
diff --git a/README.md b/README.md
index dfda277..60c5e05 100644
--- a/README.md
+++ b/README.md
@@ -86,7 +86,7 @@ This work is published under [MIT License][license].
 [image]: https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/
 [demo]: https://cotes2020.github.io/chirpy-demo/
 [wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
-[contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md
+[contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md
 [contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors
 [lib]: https://github.com/cotes2020/chirpy-static-assets
 [jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy
diff --git a/_config.yml b/_config.yml
index 4fded07..960148f 100644
--- a/_config.yml
+++ b/_config.yml
@@ -177,6 +177,7 @@ compress_html:
 exclude:
   - "*.gem"
   - "*.gemspec"
+  - docs
   - tools
   - README.md
   - CHANGELOG.md
diff --git a/.github/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
similarity index 100%
rename from .github/CODE_OF_CONDUCT.md
rename to docs/CODE_OF_CONDUCT.md
diff --git a/.github/CONTRIBUTING.md b/docs/CONTRIBUTING.md
similarity index 98%
rename from .github/CONTRIBUTING.md
rename to docs/CONTRIBUTING.md
index 4522a8e..b86cb2d 100644
--- a/.github/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -84,8 +84,8 @@ When development is complete, create a [Conventional Commit][cc] with Git.
 
 ## Helpful Resources
 
-- [Code of conduct](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CODE_OF_CONDUCT.md)
-- [Security policy](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/SECURITY.md)
+- [Code of conduct](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CODE_OF_CONDUCT.md)
+- [Security policy](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/SECURITY.md)
 
 [latest-ver]: https://github.com/cotes2020/jekyll-theme-chirpy/releases/latest
 [wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
diff --git a/.github/SECURITY.md b/docs/SECURITY.md
similarity index 100%
rename from .github/SECURITY.md
rename to docs/SECURITY.md