docs!: move the documentation files to docs/ dir

.github/vale_styles/Vocab/Base/accept.txt

@@ -1,5 +1,6 @@
 actionlint
 Base Template Repository
+Base Template Repository Documentation
 boilerplate
 Commitizen
 commitlint

.github/workflows/test.yml

@@ -23,7 +23,7 @@ jobs:
         uses: errata-ai/vale-action@v2
         with:
           files: >
-            ["README.md", "CONTRIBUTING.md", "SECURITY.md",
+            ["README.md", "docs/CONTRIBUTING.md", "docs/SECURITY.md",
             ".github/PULL_REQUEST_TEMPLATE.md", ".github/ISSUE_TEMPLATE"]
           reporter: github-check
           fail_on_error: true

.markdownlintignore

@@ -1,4 +1,4 @@
 node_modules/
 /.github/vale_styles/
-/CHANGELOG.md
-/CODE_OF_CONDUCT.md
+/docs/CHANGELOG.md
+/docs/CODE_OF_CONDUCT.md

.releaserc.yml

@@ -14,8 +14,19 @@ branches:
 plugins:
   - "@semantic-release/commit-analyzer"
   - "@semantic-release/release-notes-generator"
-  - "@semantic-release/changelog"
+  -
+    - "@semantic-release/changelog"
+    - changelogFile: docs/CHANGELOG.md
   - "@semantic-release/npm"
-  - "@semantic-release/git"
+  -
+    - "@semantic-release/git"
+    # https://github.com/semantic-release/git#options
+    # Default: ['CHANGELOG.md', 'package.json', 'package-lock.json',
+    #          'npm-shrinkwrap.json']
+    - assets:
+        - docs/CHANGELOG.md
+        - package.json
+        - package-lock.json
+        - npm-shrinkwrap.json
   - "@semantic-release/github"
 preset: conventionalcommits

Makefile

@@ -10,7 +10,7 @@ lint-npm:
 	npm run lint
 
 lint-text:
-	vale README.md CONTRIBUTING.md SECURITY.md .github/*.md .github/ISSUE_TEMPLATE
+	vale README.md docs/CONTRIBUTING.md docs/SECURITY.md .github/*.md .github/ISSUE_TEMPLATE
 
 lint-yml:
 	yamllint --strict .

README.md

@@ -2,7 +2,7 @@
 
 [![Test](https://github.com/haru52/base_template/actions/workflows/test.yml/badge.svg)](https://github.com/haru52/base_template/actions/workflows/test.yml)
 [![Release](https://github.com/haru52/base_template/actions/workflows/release.yml/badge.svg)](https://github.com/haru52/base_template/actions/workflows/release.yml)
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](docs/CODE_OF_CONDUCT.md)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen.github.io/cz-cli/)
 [![semantic-release: conventionalcommits](https://img.shields.io/badge/semantic--release-conventionalcommits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
 
@@ -105,7 +105,7 @@ Please use [Base Template CLI][base-template-cli].
 
 ## Contributing
 
-[Contributing Guideline](CONTRIBUTING.md)
+[Contributing Guideline](docs/CONTRIBUTING.md)
 
 <!-- vale Microsoft.Vocab = NO -->
 ## Author

docs/README.md

@@ -0,0 +1,6 @@
+# Base Template Repository Documentation
+
+- [Changelog](CHANGELOG.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Contributing Guideline](CONTRIBUTING.md)
+- [Security Policy](SECURITY.md)