Skip to content

Commit 9e3dfce

Browse files
committed
feat(docs): Main page documentation updates.
1 parent cb52933 commit 9e3dfce

File tree

4 files changed

+82
-12
lines changed

4 files changed

+82
-12
lines changed

README.md

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,42 @@
1717

1818
<hr />
1919

20-
<p><strong>CI/CD Check List:</strong></p>
20+
<p><strong>Utilizes:</strong><br />
21+
The <strong>github-docs-cookiecutter</strong> depends on the following repositories for its documentation and sub-features.</p>
22+
23+
<ul>
24+
<li><a href="https://github.com/jcook3701/cookiecutter-cookiecutter">cookiecutter-cookiecutter</a> Generates cookiecutter template projects and is able to be queried by generated projects for autogenerated file updates.</li>
25+
<li><a href="https://github.com/jcook3701/github-docs-cookiecutter">Github docs</a> via the cookiecutter-cookiecutter this project is used as a sub-template to generate documentation.</li>
26+
<li><a href="https://github.com/jcook3701/nutri-matic">Nutri-Matic</a> cookiecutter hooks and tools for documentation build. The nutrimatic package has become a .</li>
27+
</ul>
28+
29+
<p><strong>Maintains:</strong><br />
30+
The <strong>github-docs-cookiecutter</strong> is used to maintain documentation for the following projects.</p>
31+
32+
<p><strong>Cookiecutter Projects:</strong></p>
33+
<ul>
34+
<li>**<a href="https://github.com/jcook3701/cookiecutter-cookiecutter">cookiecutter-cookiecutter</a></li>
35+
<li>**<a href="https://github.com/jcook3701/python3-cookiecutter">python3-cookiecutter</a></li>
36+
<li>**<a href="https://github.com/jcook3701/ansible-galaxy-cookiecutter">ansible-galaxy-cookiecutter</a></li>
37+
</ul>
38+
39+
<p><strong>Python Projects:</strong></p>
40+
<ul>
41+
<li>**<a href="https://github.com/jcook3701/nutri-matic">Nutri-Matic</a></li>
42+
</ul>
43+
44+
<p><strong>Ansible Projects:</strong></p>
45+
<ul>
46+
<li><strong><a href="https://github.com/jcook3701/jcook3701.docker">jcook3701.docker</a></strong> Ansible Galaxy collection used to install docker packages.</li>
47+
<li><strong><a href="https://github.com/jcook3701/jcook3701.flatpak">jcook3701.flatpak</a></strong> Ansible Galaxy collection used to install flatpak packages.</li>
48+
<li><strong><a href="https://github.com/jcook3701/jcook3701.pkgs">jcook3701.pkgs</a></strong> Ansible Galaxy collection used to install system (Debian, Ubuntu, RHEL) packages.</li>
49+
<li><strong><a href="https://github.com/jcook3701/jcook3701.source">jcook3701.source</a></strong> Ansible Galaxy collection used to install packages from source code.</li>
50+
<li><strong><a href="https://github.com/jcook3701/jcook3701.snap">jcook3701.snap</a></strong> Ansible Galaxy collection used to install snap packages.</li>
51+
</ul>
52+
53+
<hr />
54+
55+
<p>🛠️ <strong>CI/CD Check List:</strong></p>
2156

2257
<!-- [![CLA assistant](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/cla.yml/badge.svg)]() -->
2358
<ul>
@@ -56,18 +91,18 @@
5691

5792
<hr />
5893

59-
<h2 id="getting-started">Getting Started</h2>
94+
<h2 id="-getting-started">🌱 Getting Started</h2>
6095

6196
<ul>
6297
<li><a href="https://jcook3701.github.io/github-docs-cookiecutter/manual/setup-guide/requirements">Requirements</a></li>
6398
<li><a href="https://jcook3701.github.io/github-docs-cookiecutter/manual/introduction/installation-guide">Installation guide</a></li>
6499
</ul>
65100

66-
<h2 id="documentation">Documentation</h2>
101+
<h2 id="-documentation">📚 Documentation</h2>
67102

68103
<p>The github-docs-cookiecutter documentation is available at <a href="https://jcook3701.github.io/github-docs-cookiecutter">docs</a>.</p>
69104

70-
<h2 id="contributing">Contributing</h2>
105+
<h2 id="-contributing">🤝 Contributing</h2>
71106

72107
<p>If you’re interested in contributing to the github-docs-cookiecutter project:</p>
73108
<ul>
@@ -78,13 +113,13 @@
78113

79114
<hr />
80115

81-
<h2 id="authors-notes">Authors Notes</h2>
116+
<h2 id="-authors-notes">🍹 Authors Notes</h2>
82117

83118
<ol>
84119
<li>This code currently works with cookiecutter (2.6) from PyPi repositories.</li>
85120
</ol>
86121

87-
<h2 id="license">License</h2>
122+
<h2 id="️-license">⚖️ License</h2>
88123

89124
<p>Copyright (c) 2025-2026, Jared Cook</p>
90125

changelogs/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,10 @@ Feat 021 (#57)
236236

237237
- *(template)* Updates to template cookiecutter.json file.
238238
- *(docs)* Fix for index file to ensure description doesn't mess with page header.
239+
240+
### 🚀 Added
241+
242+
- *(docs)* Fun emojis added to template readme.
239243
## [0.1.0] - 2025-12-05
240244

241245
### ⚙️ Miscellaneous

changelogs/releases/v0.1.1.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,3 +236,7 @@ Feat 021 (#57)
236236

237237
- *(template)* Updates to template cookiecutter.json file.
238238
- *(docs)* Fix for index file to ensure description doesn't mess with page header.
239+
240+
### 🚀 Added
241+
242+
- *(docs)* Fun emojis added to template readme.

docs/jekyll/README.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,34 @@ Template cookiecutter project for Github Pages (Jekyll). This project can utili
1212

1313
***
1414

15-
**CI/CD Check List:**
15+
**Utilizes:**
16+
The **{{ site.title }}** depends on the following repositories for its documentation and sub-features.
17+
18+
* [cookiecutter-cookiecutter](https://github.com/jcook3701/cookiecutter-cookiecutter) Generates cookiecutter template projects and is able to be queried by generated projects for autogenerated file updates.
19+
* [Github docs](https://github.com/jcook3701/github-docs-cookiecutter) via the cookiecutter-cookiecutter this project is used as a sub-template to generate documentation.
20+
* [Nutri-Matic](https://github.com/jcook3701/nutri-matic) cookiecutter hooks and tools for documentation build. The nutrimatic package has become a .
21+
22+
**Maintains:**
23+
The **{{ site.title }}** is used to maintain documentation for the following projects.
24+
25+
**Cookiecutter Projects:**
26+
* **[cookiecutter-cookiecutter](https://github.com/jcook3701/cookiecutter-cookiecutter)
27+
* **[python3-cookiecutter](https://github.com/jcook3701/python3-cookiecutter)
28+
* **[ansible-galaxy-cookiecutter](https://github.com/jcook3701/ansible-galaxy-cookiecutter)
29+
30+
**Python Projects:**
31+
* **[Nutri-Matic](https://github.com/jcook3701/nutri-matic)
32+
33+
**Ansible Projects:**
34+
* **[jcook3701.docker](https://github.com/jcook3701/jcook3701.docker)** Ansible Galaxy collection used to install docker packages.
35+
* **[jcook3701.flatpak](https://github.com/jcook3701/jcook3701.flatpak)** Ansible Galaxy collection used to install flatpak packages.
36+
* **[jcook3701.pkgs](https://github.com/jcook3701/jcook3701.pkgs)** Ansible Galaxy collection used to install system (Debian, Ubuntu, RHEL) packages.
37+
* **[jcook3701.source](https://github.com/jcook3701/jcook3701.source)** Ansible Galaxy collection used to install packages from source code.
38+
* **[jcook3701.snap](https://github.com/jcook3701/jcook3701.snap)** Ansible Galaxy collection used to install snap packages.
39+
40+
***
41+
42+
🛠️ **CI/CD Check List:**
1643

1744
<!-- [![CLA assistant](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/cla.yml/badge.svg)]() -->
1845
* ![dependency-check](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/dependency-check.yml/badge.svg)
@@ -47,16 +74,16 @@ Utilization of [nutri-matic](https://github.com/jcook3701/nutri-matic) is the op
4774

4875
***
4976

50-
## Getting Started
77+
## 🌱 Getting Started
5178

5279
* [Requirements]({{ site.github_io_url }}/manual/setup-guide/requirements)
5380
* [Installation guide]({{ site.github_io_url }}/manual/introduction/installation-guide)
5481

55-
## Documentation
82+
## 📚 Documentation
5683

5784
The {{ site.title }} documentation is available at [docs]({{ site.github_io_url }}).
5885

59-
## Contributing
86+
## 🤝 Contributing
6087

6188
If you're interested in contributing to the {{ site.title }} project:
6289
* Start by reading the [contributing guide]({{ site.github_io_url }}/manual/developer-resources/contribute).
@@ -65,11 +92,11 @@ If you're interested in contributing to the {{ site.title }} project:
6592

6693
***
6794

68-
## Authors Notes
95+
## 🍹 Authors Notes
6996

7097
1. This code currently works with cookiecutter (2.6) from PyPi repositories.
7198

72-
## License
99+
## ⚖️ License
73100

74101
{{ site.copyright }}
75102

0 commit comments

Comments
 (0)