diff --git a/changelogs/CHANGELOG.md b/changelogs/CHANGELOG.md index 7872574..03b48a7 100644 --- a/changelogs/CHANGELOG.md +++ b/changelogs/CHANGELOG.md @@ -209,16 +209,27 @@ Feat 018 (#51) - Merge pull request #54 from jcook3701/develop Feat 019 (#53) +- Feat 020 (#55) + +* fix(docs): readme updates. + +* fix(docs): readme ci/cd checklist updates. + +* fix(docs): Fixed FAQ page name. + +* feat(docs): updates to git commit message info. +- Merge pull request #56 from jcook3701/develop + +Feat 020 (#55) ### 🐛 Fixed - *(template)* Updates to template cookiecutter.json file. -- *(docs)* Readme updates. -- *(docs)* Readme updates. -- *(docs)* Readme updates. -- *(docs)* Readme updates. -- *(docs)* Readme ci/cd checklist updates. -- *(docs)* Fixed FAQ page name. +- *(upgrader)* Fix to move project back to cookiecutter template project. + +### 🚀 Added + +- *(upgrader)* Updates to upgrader configuration file to fix hooks upgrade. ## [0.1.0] - 2025-12-05 ### ⚙️ Miscellaneous diff --git a/changelogs/releases/v0.1.1.md b/changelogs/releases/v0.1.1.md index b5b1434..e28760c 100644 --- a/changelogs/releases/v0.1.1.md +++ b/changelogs/releases/v0.1.1.md @@ -209,13 +209,24 @@ Feat 018 (#51) - Merge pull request #54 from jcook3701/develop Feat 019 (#53) +- Feat 020 (#55) + +* fix(docs): readme updates. + +* fix(docs): readme ci/cd checklist updates. + +* fix(docs): Fixed FAQ page name. + +* feat(docs): updates to git commit message info. +- Merge pull request #56 from jcook3701/develop + +Feat 020 (#55) ### 🐛 Fixed - *(template)* Updates to template cookiecutter.json file. -- *(docs)* Readme updates. -- *(docs)* Readme updates. -- *(docs)* Readme updates. -- *(docs)* Readme updates. -- *(docs)* Readme ci/cd checklist updates. -- *(docs)* Fixed FAQ page name. +- *(upgrader)* Fix to move project back to cookiecutter template project. + +### 🚀 Added + +- *(upgrader)* Updates to upgrader configuration file to fix hooks upgrade. diff --git a/cspell.json b/cspell.json index c8994f3..b1caecb 100644 --- a/cspell.json +++ b/cspell.json @@ -3,6 +3,8 @@ "language": "en", "useGitignore": true, "words": [ + "antsibull", + "antsichaut", "bumpversion", "cla", "ccla", @@ -16,16 +18,21 @@ "endmacro", "endraw", "endset", + "flatpak", "gitcliff", "githubusercontent", "icla", "mkdirp", + "nameisok", "nutrimatic", "nutri-matic", + "pkg", + "pkgs", "pipaudit", "pip-audit", "pyproject", "pytest", + "pyupgrade", "rpmnew", "rustc", "streetsidesoftware", @@ -35,7 +42,8 @@ "venv", "visualstudio", "vsmarketplacebadge", - "yaml" + "yaml", + "yamlfixer" ], "flagWords": [ "hte" diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index 6973f0d..9be9caf 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -41,6 +41,7 @@ "add_sphinx_docs": false, "author": "Jared Cook", "buymeacoffee_username": "jcook3701", + "changelog": "none", "company": null, "contribution_model": "CLA", "copyright": "Copyright (c) 2025-2026, Jared Cook", @@ -58,7 +59,7 @@ "publication_year": "2025", "python_version": "3.11", "repo_url": "https://github.com/jcook3701/github-docs-cookiecutter", - "template_type": "documentation", + "template_type": "cookiecutter", "theme": "just-the-docs/just-the-docs@v0.11.0", "timezone": "America/Los_Angeles", "twitter_username": "", diff --git a/docs/jekyll/_manual/contribute/git-commit-message.md b/docs/jekyll/_manual/contribute/git-commit-message.md index 25fcce7..9262f8c 100644 --- a/docs/jekyll/_manual/contribute/git-commit-message.md +++ b/docs/jekyll/_manual/contribute/git-commit-message.md @@ -8,7 +8,21 @@ parent: Contribute Commits are required to be conventional git commit messages. This helps with the auto-generation of the changelog files and is enforced by [pre-commit](https://pre-commit.com/). -__example:__ +**options (default):** + +* docs +* chore +* feat +* fix +* refactor +* ci +* test +* perf +* revert +* build +* style + +**example:** ```shell [optional scope]: diff --git a/docs/jekyll/_manual/troubleshooting/faq.md b/docs/jekyll/_manual/troubleshooting/faq.md index ab86dde..c31d2f3 100644 --- a/docs/jekyll/_manual/troubleshooting/faq.md +++ b/docs/jekyll/_manual/troubleshooting/faq.md @@ -1,6 +1,6 @@ --- layout: default -title: Requirements +title: FAQ nav_order: 1 parent: Troubleshooting --- diff --git a/docs/jekyll/_manual/troubleshooting/index.md b/docs/jekyll/_manual/troubleshooting/index.md index 1c4fb4d..22bc5ce 100644 --- a/docs/jekyll/_manual/troubleshooting/index.md +++ b/docs/jekyll/_manual/troubleshooting/index.md @@ -6,4 +6,4 @@ has_children: true --- ## Troubleshooting github-docs-cookiecutter -* **[FAQ]({% link _manual/troubleshooting/faq.md %})** Common questions are answered in our [Frequently Asked Questions](https://jcook3701.github.io/github-docs-cookiecutter/manual/troubleshooting/faq.md). +* **[FAQ]({% link _manual/troubleshooting/faq.md %})** Common questions are answered in our Frequently Asked Questions diff --git a/pyproject.toml b/pyproject.toml index 75ff2f0..ee532bf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -30,7 +30,7 @@ authors = [ ] readme = "README.md" license = "AGPL-3.0-or-later" -license-files = ["LICENSE"] +license-files = ["LICENSE.md"] requires-python = ">=3.11" dependencies = [ "nutri-matic>=0.1",