Skip to content

Commit 9cabe1d

Browse files
jcook3701jcook3701
committed
fix(docs): readme updates.
1 parent e6375fa commit 9cabe1d

5 files changed

Lines changed: 119 additions & 120 deletions

File tree

‎README.md‎

Lines changed: 38 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
-->
66
<h1 id="github-docs-cookiecutter">github-docs-cookiecutter</h1>
77

8+
<p><a href="LICENSE.md"><img src="https://img.shields.io/github/license/jcook3701/github-docs-cookiecutter" alt="License" /></a></p>
9+
810
<p><strong>Author:</strong> Jared Cook<br />
911
<strong>Version:</strong> 0.1.1</p>
1012

@@ -15,7 +17,7 @@
1517

1618
<hr />
1719

18-
<p><a href="LICENSE"><img src="https://img.shields.io/github/license/jcook3701/github-docs-cookiecutter" alt="License" /></a></p>
20+
<p><a href="LICENSE.md"><img src="https://img.shields.io/github/license/jcook3701/github-docs-cookiecutter" alt="License" /></a></p>
1921

2022
<!-- [![CLA assistant](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/cla.yml/badge.svg)]() -->
2123
<p><img src="https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/dependency-check.yml/badge.svg" alt="dependency-check" />
@@ -28,7 +30,8 @@
2830

2931
<hr />
3032

31-
<h2 id="usage-examples">Usage Examples:</h2>
33+
<h2 id="usage-examples">Usage Examples</h2>
34+
3235
<p><strong>Example:</strong> Pull from main branch.</p>
3336
<ol>
3437
<li>Pull Project with cookiecutter command:
@@ -42,54 +45,48 @@
4245
</li>
4346
</ol>
4447

45-
<h2 id="advance-examples">Advance Examples:</h2>
48+
<h2 id="advance-examples">Advance Examples</h2>
49+
4650
<p><strong>Note:</strong> The real intention of this project is to call it as a hook within other cookiecutter projects as shown below.<br />
4751
<strong>Explanation:</strong> <a href="https://github.com/jcook3701/ansible-galaxy-cookiecutter">ansible-galaxy-cookiecutter</a> template utilizes <a href="https://github.com/jcook3701/nutri-matic">nutri-matic</a> hooks to pull both this documentation template along with <a href="https://github.com/jcook3701/sphinx-cookiecutter">sphinx-cookiecutter</a> template into generated project <code class="language-plaintext highlighter-rouge">$(PROJECT_ROOT)/docs/</code>.</p>
4852

4953
<p>Utilization of <a href="https://github.com/jcook3701/nutri-matic">nutri-matic</a> is the optimal way of integrating this template in projects.</p>
5054

5155
<hr />
5256

53-
<h2 id="development-strategy">Development Strategy:</h2>
54-
<p><strong>Note:</strong> All Makefile commands are used in ci/cd to ensure that if they pass locally they should also pass once pushed to github.</p>
55-
<h3 id="️-build-environment-venv">🐍️ Build environment (.venv)</h3>
56-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make <span class="nb">install</span>
57-
</code></pre></div></div>
58-
<h3 id="-dependency-management-deptry">🧬 Dependency Management (deptry)</h3>
59-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make dependency-check
60-
</code></pre></div></div>
61-
<h3 id="️-security-audit-pip-audit">🛡️ Security Audit (pip-audit)</h3>
62-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make security
63-
</code></pre></div></div>
64-
<h3 id="-formatting-black">🎨 Formatting (black)</h3>
65-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make format-check
66-
</code></pre></div></div>
67-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make format-fix
68-
</code></pre></div></div>
69-
<h3 id="-linting-jinja2-cli-ruff-tomllint--yaml-lint">🔍 Linting (jinja2-cli, ruff, tomllint, &amp; yaml-lint)</h3>
70-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make lint-check
71-
</code></pre></div></div>
72-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make lint-fix
73-
</code></pre></div></div>
74-
<h3 id="-spellchecking-codespell">🎓 Spellchecking (codespell)</h3>
75-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make spellcheck
76-
</code></pre></div></div>
77-
<h3 id="-typechecking-mypy">🧠 Typechecking (mypy)</h3>
78-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make typecheck
79-
</code></pre></div></div>
80-
<h3 id="-testing-pytest">🧪 Testing (pytest)</h3>
81-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make <span class="nb">test</span>
82-
</code></pre></div></div>
83-
<h3 id="-release-git-tag">🚀 Release (git tag)</h3>
84-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make release
85-
</code></pre></div></div>
86-
<h3 id="-build-help">❓ Build Help</h3>
87-
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make <span class="nb">help</span>
88-
</code></pre></div></div>
57+
<h2 id="getting-started">Getting Started</h2>
58+
59+
<ul>
60+
<li><a href="https://jcook3701.github.io/github-docs-cookiecutter/manual/setup-guide/requirements">Requirements</a></li>
61+
<li><a href="https://jcook3701.github.io/github-docs-cookiecutter/manual/introduction/installation-guide">Installation guide</a></li>
62+
</ul>
63+
64+
<h2 id="documentation">Documentation</h2>
65+
66+
<p>The github-docs-cookiecutter documentation is available at <a href="https://jcook3701.github.io/github-docs-cookiecutter">docs</a>.</p>
67+
68+
<h2 id="contributing">Contributing</h2>
69+
70+
<p>If you’re interested in contributing to the github-docs-cookiecutter project:</p>
71+
<ul>
72+
<li>Start by reading the <a href="https://jcook3701.github.io/github-docs-cookiecutter/manual/developer-resources/contribute">contributing guide</a>.</li>
73+
<li>Learn how to setup your local environment, in our <a href="https://jcook3701.github.io/github-docs-cookiecutter/manual/contribute/developer-guide">developer guide</a>.</li>
74+
<li>Look through our <a href="https://jcook3701.github.io/github-docs-cookiecutter/manual/contribute/style-guides/index">style guide</a>.</li>
75+
</ul>
8976

9077
<hr />
9178

92-
<h3 id="authors-notes">Authors Notes:</h3>
79+
<h2 id="authors-notes">Authors Notes</h2>
80+
9381
<ol>
94-
<li>This code currently works with cookiecutter 1.7 from Ubuntu’s apt repositories.</li>
82+
<li>This code currently works with cookiecutter (2.6) from PyPi repositories.</li>
9583
</ol>
84+
85+
<h2 id="license">License</h2>
86+
87+
<p>Copyright (c) 2025-2026, Jared Cook</p>
88+
89+
<p>This project is licensed under the <strong>AGPL-3.0-or-later License</strong>.
90+
See the <a href="https://github.com/jcook3701/github-docs-cookiecutter/blob/master/LICENSE.md">LICENSE</a> file for the full license text.</p>
91+
92+
<p>SPDX-License-Identifier: AGPL-3.0-or-later</p>

‎changelogs/CHANGELOG.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -196,16 +196,23 @@ Feat 017 (#49)
196196
- Merge pull request #52 from jcook3701/develop
197197

198198
Feat 018 (#51)
199+
- *(CLA)* Creating file for storing CLA Signatures.
200+
- Feat 019 (#53)
199201

200-
### 🐛 Fixed
202+
* fix(cla): removed signatures folder as it should be re-generated as cla/v1/signatures.json.
201203

202-
- *(template)* Updates to template cookiecutter.json file.
203-
- *(cla)* Removed signatures folder as it should be re-generated as cla/v1/signatures.json.
204-
- *(configuration)* Update to template_type configuration.
204+
* feat(docs): Minor documentation update.
205+
206+
* fix(configuration): Update to template_type configuration.
207+
208+
* chore(update): Update template using ```cookiecutter_project_upgrader```
209+
- Merge pull request #54 from jcook3701/develop
205210

206-
### 🚀 Added
211+
Feat 019 (#53)
207212

208-
- *(docs)* Minor documentation update.
213+
### 🐛 Fixed
214+
215+
- *(template)* Updates to template cookiecutter.json file.
209216
## [0.1.0] - 2025-12-05
210217

211218
### ⚙️ Miscellaneous

‎changelogs/releases/v0.1.1.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -196,13 +196,20 @@ Feat 017 (#49)
196196
- Merge pull request #52 from jcook3701/develop
197197

198198
Feat 018 (#51)
199+
- *(CLA)* Creating file for storing CLA Signatures.
200+
- Feat 019 (#53)
199201

200-
### 🐛 Fixed
202+
* fix(cla): removed signatures folder as it should be re-generated as cla/v1/signatures.json.
201203

202-
- *(template)* Updates to template cookiecutter.json file.
203-
- *(cla)* Removed signatures folder as it should be re-generated as cla/v1/signatures.json.
204-
- *(configuration)* Update to template_type configuration.
204+
* feat(docs): Minor documentation update.
205+
206+
* fix(configuration): Update to template_type configuration.
207+
208+
* chore(update): Update template using ```cookiecutter_project_upgrader```
209+
- Merge pull request #54 from jcook3701/develop
205210

206-
### 🚀 Added
211+
Feat 019 (#53)
207212

208-
- *(docs)* Minor documentation update.
213+
### 🐛 Fixed
214+
215+
- *(template)* Updates to template cookiecutter.json file.

‎docs/jekyll/README.md‎

Lines changed: 40 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# {{ site.title }}
22

3-
__Author:__ {{ site.author }}
4-
__Version:__ {{ site.version }}
3+
[![License](https://img.shields.io/github/license/{{ site.github_username }}{{ site.baseurl }})](LICENSE.md)
4+
5+
**Author:** {{ site.author }}
6+
**Version:** {{ site.version }}
57

68
## Overview
79
{{ site.description }}
@@ -10,7 +12,7 @@ Template cookiecutter project for Github Pages (Jekyll). This project can utili
1012

1113
***
1214

13-
[![License](https://img.shields.io/github/license/jcook3701/github-docs-cookiecutter)](LICENSE)
15+
[![License](https://img.shields.io/github/license/jcook3701/github-docs-cookiecutter)](LICENSE.md)
1416

1517
<!-- [![CLA assistant](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/cla.yml/badge.svg)]() -->
1618
![dependency-check](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/dependency-check.yml/badge.svg)
@@ -23,76 +25,55 @@ Template cookiecutter project for Github Pages (Jekyll). This project can utili
2325

2426
***
2527

26-
## Usage Examples:
27-
__Example:__ Pull from main branch.
28+
## Usage Examples
29+
30+
**Example:** Pull from main branch.
2831
1. Pull Project with cookiecutter command:
2932
``` shell
3033
$ cookiecutter git@github.com:jcook3701/github-docs-cookiecutter.git
3134
```
32-
__Example:__ Pull from develop branch.
35+
**Example:** Pull from develop branch.
3336
1. Pull code from development branch while testing updates.
3437
``` shell
3538
$ cookiecutter git@github.com:jcook3701/github-docs-cookiecutter.git --checkout develop
3639
```
3740

38-
## Advance Examples:
39-
__Note:__ The real intention of this project is to call it as a hook within other cookiecutter projects as shown below.
40-
__Explanation:__ [ansible-galaxy-cookiecutter](https://github.com/jcook3701/ansible-galaxy-cookiecutter) template utilizes [nutri-matic](https://github.com/jcook3701/nutri-matic) hooks to pull both this documentation template along with [sphinx-cookiecutter](https://github.com/jcook3701/sphinx-cookiecutter) template into generated project ```$(PROJECT_ROOT)/docs/```.
41+
## Advance Examples
42+
43+
**Note:** The real intention of this project is to call it as a hook within other cookiecutter projects as shown below.
44+
**Explanation:** [ansible-galaxy-cookiecutter](https://github.com/jcook3701/ansible-galaxy-cookiecutter) template utilizes [nutri-matic](https://github.com/jcook3701/nutri-matic) hooks to pull both this documentation template along with [sphinx-cookiecutter](https://github.com/jcook3701/sphinx-cookiecutter) template into generated project ```$(PROJECT_ROOT)/docs/```.
4145

4246
Utilization of [nutri-matic](https://github.com/jcook3701/nutri-matic) is the optimal way of integrating this template in projects.
4347

4448
***
4549

46-
## Development Strategy:
47-
__Note:__ All Makefile commands are used in ci/cd to ensure that if they pass locally they should also pass once pushed to github.
48-
### 🐍️ Build environment (.venv)
49-
``` shell
50-
$ make install
51-
```
52-
### 🧬 Dependency Management (deptry)
53-
```shell
54-
$ make dependency-check
55-
```
56-
### 🛡️ Security Audit (pip-audit)
57-
```shell
58-
$ make security
59-
```
60-
### 🎨 Formatting (black)
61-
```shell
62-
$ make format-check
63-
```
64-
```shell
65-
$ make format-fix
66-
```
67-
### 🔍 Linting (jinja2-cli, ruff, tomllint, & yaml-lint)
68-
``` shell
69-
$ make lint-check
70-
```
71-
``` shell
72-
$ make lint-fix
73-
```
74-
### 🎓 Spellchecking (codespell)
75-
```shell
76-
$ make spellcheck
77-
```
78-
### 🧠 Typechecking (mypy)
79-
``` shell
80-
$ make typecheck
81-
```
82-
### 🧪 Testing (pytest)
83-
``` shell
84-
$ make test
85-
```
86-
### 🚀 Release (git tag)
87-
```shell
88-
$ make release
89-
```
90-
### ❓ Build Help
91-
``` shell
92-
$ make help
93-
```
50+
## Getting Started
51+
52+
* [Requirements]({{ site.github_io_url }}/manual/setup-guide/requirements)
53+
* [Installation guide]({{ site.github_io_url }}/manual/introduction/installation-guide)
54+
55+
## Documentation
56+
57+
The {{ site.title }} documentation is available at [docs]({{ site.github_io_url }}).
58+
59+
## Contributing
60+
61+
If you're interested in contributing to the {{ site.title }} project:
62+
* Start by reading the [contributing guide]({{ site.github_io_url }}/manual/developer-resources/contribute).
63+
* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/manual/contribute/developer-guide).
64+
* Look through our [style guide]({{ site.github_io_url }}/manual/contribute/style-guides/index).
9465

9566
***
9667

97-
### Authors Notes:
98-
1. This code currently works with cookiecutter 1.7 from Ubuntu's apt repositories.
68+
## Authors Notes
69+
70+
1. This code currently works with cookiecutter (2.6) from PyPi repositories.
71+
72+
## License
73+
74+
{{ site.copyright }}
75+
76+
This project is licensed under the **{{ site.license }} License**.
77+
See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text.
78+
79+
SPDX-License-Identifier: {{ site.license }}

‎{{ cookiecutter.project_slug }}/README.md‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# {{ site.title }}
22

3-
[![License](https://img.shields.io/github/license/{{ site.github_username }}{{ site.baseurl }})](LICENSE)
3+
[![License](https://img.shields.io/github/license/{{ site.github_username }}{{ site.baseurl }})](LICENSE.md)
44

5-
__Author:__ {{ site.author }}
6-
__Version:__ {{ site.version }}
5+
**Author:** {{ site.author }}
6+
**Version:** {{ site.version }}
77

88
## Overview
9+
910
{{ site.description }}
1011

11-
__CI/CD Check List:__
12+
**CI/CD Check List:**
13+
1214
* ![dependency-check]({{ site.repo_url }}/actions/workflows/dependency-check.yml/badge.svg)
1315
* ![format-check]({{ site.repo_url }}/actions/workflows/format-check.yml/badge.svg)
1416
* ![lint-check]({{ site.repo_url }}/actions/workflows/lint-check.yml/badge.svg)
@@ -22,21 +24,26 @@ __CI/CD Check List:__
2224
<!-- NOTE: On this page all links need to be from site.github_io_url and not jinja2 links -->
2325

2426
## Getting Started
27+
28+
* [Requirements]({{ site.github_io_url }}/manual/setup-guide/requirements)
2529
* [Installation guide]({{ site.github_io_url }}/manual/introduction/installation-guide)
2630

2731
## Documentation
32+
2833
The {{ site.title }} documentation is available at [docs]({{ site.github_io_url }}).
2934

3035
## Contributing
36+
3137
If you're interested in contributing to the {{ site.title }} project:
32-
* Start by reading the [contributing guide]({{ site.github_io_url }}/developer-resources/contribute).
33-
* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/contribute/developer-guide).
34-
* Look through our [style guide]({{ site.github_io_url }}/contribute/style-guides/index).
38+
* Start by reading the [contributing guide]({{ site.github_io_url }}/manual/developer-resources/contribute).
39+
* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/manual/contribute/developer-guide).
40+
* Look through our [style guide]({{ site.github_io_url }}/manual/contribute/style-guides/index).
3541

3642
## License
43+
3744
{{ site.copyright }}
3845

39-
This project is licensed under the __{{ site.license }} License__.
46+
This project is licensed under the **{{ site.license }} License**.
4047
See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text.
4148

4249
SPDX-License-Identifier: {{ site.license }}

0 commit comments

Comments
 (0)