feat(docs): updates to setup, getting-started, and initial tutorials.

jcook3701 · jcook3701 · commit 13bc6f76e3cf · 2026-01-27T20:28:45.000-08:00
diff --git a/changelogs/CHANGELOG.md b/changelogs/CHANGELOG.md
@@ -178,6 +178,7 @@ Feat 016 (#47)
 ### 🐛 Fixed
 
 - *(template)* Updates to template cookiecutter.json file.
+- *(configuration)* I think this should fix the last of the problems with main showing up where master should for this repository.
 ## [0.1.0] - 2025-12-05
 
 ### ⚙️  Miscellaneous
diff --git a/changelogs/releases/v0.1.1.md b/changelogs/releases/v0.1.1.md
@@ -2,7 +2,7 @@
 # Changelog:
 # --------------------------------------------------
 
-## [0.1.1] - 2026-01-27
+## [0.1.1] - 2026-01-28
 
 ### ⚙️  Miscellaneous
 
@@ -178,3 +178,4 @@ Feat 016 (#47)
 ### 🐛 Fixed
 
 - *(template)* Updates to template cookiecutter.json file.
+- *(configuration)* I think this should fix the last of the problems with main showing up where master should for this repository.
diff --git a/cookiecutter.json b/cookiecutter.json
@@ -9,15 +9,15 @@
     "America/Los_Angeles"
   ],
   "license": [
-    "MIT",
     "AGPL-3.0-or-later",
     "AGPL-3.0-only",
+    "Apache-2.0",
     "GPL-3.0-or-later",
     "GPL-3.0-only",
-    "Apache-2.0",
     "BSD-3-Clause",
     "BSD-2-Clause",
     "0BSD",
+    "MIT",
     "Unlicense"
   ],
   "contribution_model": [
diff --git a/{{ cookiecutter.project_slug }}/Makefile b/{{ cookiecutter.project_slug }}/Makefile
@@ -42,7 +42,7 @@ PUBLISHDIR ?=
 # 📚 Documentation (Sphinx + Jekyll)
 # --------------------------------------------------
 RUBY_INSTALL := bundle install
-JEKYLL_BUILD := bundle exec jekyll build --quiet
+JEKYLL_BUILD := bundle exec jekyll build --trace --verbose
 JEKYLL_CLEAN := bundle exec jekyll clean
 JEKYLL_SERVE := bundle exec jekyll serve
 # --------------------------------------------------
diff --git a/{{ cookiecutter.project_slug }}/README.md b/{{ cookiecutter.project_slug }}/README.md
@@ -1,6 +1,6 @@
 # {{ site.title }}
 
-[![License](https://img.shields.io/github/license/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }})](LICENSE.md)
+[![License](https://img.shields.io/github/license/{{ site.github_username }}/{{ site.baseurl }})](LICENSE.md)
 
 __Author:__ {{ site.author }}  
 __Version:__ {{ site.version }}  
@@ -18,24 +18,25 @@ __CI/CD Check List:__
 * ![typecheck]({{ site.repo_url }}/actions/workflows/typecheck.yml/badge.svg)
 
 ***
+<!-- NOTE: This page is currently included in _copy_without_render which is why there are no raw or endraw tags. And no calls to {{ cookiecutter.etc }}. -->
+<!-- NOTE: On this page all links need to be from site.github_io_url and not jinja2 links -->
 
 ## Getting Started
-* [Get {{ cookiecutter.project_name}}]
-* [Installation guides]
+* [Installation guide]({{ site.github_io_url }}/manual/introduction/installation-guide)  
 
 ## Documentation
-The {{ cookiecutter.project_name }} documentation is available at [docs]({{ site.github_io_url }})
+The {{ site.title }} documentation is available at [docs]({{ site.github_io_url }}).  
 
 ## Contributing
-If you're interested in contributing to the {{ cookiecutter.project_name }} project:
-* Start by reading the [contributing guide]({{ site.github_io_url }}/developer-resources/contribute.md).
-* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/contribute/developer-guide.md).
-* Look through our [style guide]({{ site.github_io_url }}/contribute/style-guides/index.md).
+If you're interested in contributing to the {{ site.title }} project:  
+* Start by reading the [contributing guide]({{ site.github_io_url }}/developer-resources/contribute).  
+* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/contribute/developer-guide).  
+* Look through our [style guide]({{ site.github_io_url }}/contribute/style-guides/index).  
 
 ## License
-{{ cookiecutter.copyright }}
+{{ site.copyright }}  
 
-This project is licensed under the __{{ cookiecutter.license }} License__.
-See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text.
+This project is licensed under the __{{ site.license }} License__.
+See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text.  
 
-SPDX-License-Identifier: {{ cookiecutter.license }}
+SPDX-License-Identifier: {{ site.license }}  
diff --git a/{{ cookiecutter.project_slug }}/_config.yml b/{{ cookiecutter.project_slug }}/_config.yml
@@ -3,6 +3,8 @@
 title: "{{ cookiecutter.project_name }}"
 author: "{{ cookiecutter.author }}"
 version: "{{ cookiecutter.version }}"
+license: "{{ cookiecutter.license }}"
+copyright: "{{ cookiecutter.copyright }}"
 timezone: "{{ cookiecutter.timezone }}"
 description: "{{ cookiecutter.description }}"
 remote_theme: "{{ cookiecutter.theme }}"
diff --git a/{{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md b/{{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md
@@ -5,3 +5,41 @@ nav_order: 1
 parent: Introduction
 ---
 ## Getting started with {{ cookiecutter.project_name }}
+
+1. [Requirements]({% raw %}{% link _manual/setup-guide/requirements.md %}{% endraw %}) include python3, Nutri-Matic (docs & hooks), rust (rustup), and git-cliff (changelogs).
+    * Python3 Packages
+        1. [cookiecutter](https://github.com/cookiecutter/cookiecutter) is required to utilize templates from github.  
+        2. Nutri-Matic is required to be sourced in python environment for template cookiecutter hooks to work.
+
+I find that it easiest to clone the nutri-matic repository. Use the included makefile to install all python dependencies with ```make python-install``` from within the cloned directory.  Then, source the created file, ```.venv/bin/activate```, or point the below script variable, ```PYTHON_VENV```, to desired python virtual environment.  
+
+__Example:__ Bash script can be copied and pasted into a shell file.  Then, used to begin generating new projects.  
+__Template Options:__
+* cookiecutter-cookiecutter to generate new cookiecutter template projects.
+* python3-cookiecutter to generate python3 projects.
+* ansible-cookiecutter to generate ansible galaxy project.
+<!-- * ansible-config-cookiecutter to generate local ansible configuration. -->
+* typescript-cookiecutter to generate typescript project.
+<!-- * chrome-extension-cookiecutter to generate google chrome extension project. -->
+
+```shell
+#!/bin/bash
+
+PYTHON_VENV="~/Documents/git_repo/nutri-matic/.venv/bin/activate"
+
+PROJECT_NAME="example project name"
+TEMPLATE="cookiecutter-cookiecutter"
+LICENSE="AGPL-3.0-or-later"
+BRANCH="main"
+DESCRIPTION="Example cookiecutter template project."
+
+rm -rf $PROJECT_NAME/
+source $PYTHON_VENV
+cookiecutter git@github.com:jcook3701/$TEMPLATE.git \
+    --checkout $BRANCH \
+    --no-input \
+    project_name=$PROJECT_NAME \
+    description=$DESCRIPTION \
+    license=$LICENSE
+deactivate
+```
diff --git a/{{ cookiecutter.project_slug }}/_manual/introduction/index.md b/{{ cookiecutter.project_slug }}/_manual/introduction/index.md
@@ -5,3 +5,6 @@ nav_order: 1
 has_children: true
 ---
 ## Introduction to {{ cookiecutter.project_name }}
+
+<!-- * [Installation Guide]({% raw %}{% link _manual/introduction/installation-guide.md %}{% endraw %}) -->
+* [Getting Started]({% raw %}{% link _manual/introduction/getting-started.md %}{% endraw %})
diff --git a/{{ cookiecutter.project_slug }}/_manual/introduction/installation-guide.md b/{{ cookiecutter.project_slug }}/_manual/introduction/installation-guide.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: "Installation Guide"
+nav_order: 1
+parent: Introduction
+---
+## Installation Guide for {{ cookiecutter.project_name }} (Linux)
diff --git a/{{ cookiecutter.project_slug }}/_manual/setup-guide/index.md b/{{ cookiecutter.project_slug }}/_manual/setup-guide/index.md
@@ -6,4 +6,4 @@ has_children: true
 ---
 ## {{ cookiecutter.project_name }} Setup
 
-1. Install all [requirements]({% raw %}{%link link _manual/setup-guide/requirements.md %}{% endraw %}) to effectively pull and utilize cookiecutter template repository effectively.
+1. Install all [requirements]({% raw %}{% link _manual/setup-guide/requirements.md %}{% endraw %}) to effectively pull and utilize cookiecutter template repository effectively.
diff --git a/{{ cookiecutter.project_slug }}/_manual/setup-guide/requirements.md b/{{ cookiecutter.project_slug }}/_manual/setup-guide/requirements.md
@@ -9,11 +9,11 @@ parent: "Setup Guide"
 
 1. Python 3.11  
     ```shell
-    $ sudo apt install python3.11
+    $ sudo apt install python3.11 python3.11-dev python3.11-venv
     ```
 2. [Nutri-Matic](https://github.com/jcook3701/nutri-matic)
     __Note:__
-    __Example:__ Install with the following command (Recommended that this is installed in a python virtual environment):
+    __Example:__ Install with the following command (Recommended that this is installed in a python [virtual environment]({% raw %}{% link _manual/tutorials/create-virtual-env.md %}{% endraw %})):
     ```shell
     $ python -m pip install nutri-matic
     ```
diff --git a/{{ cookiecutter.project_slug }}/_manual/tutorials/create-virtual-env.md b/{{ cookiecutter.project_slug }}/_manual/tutorials/create-virtual-env.md
@@ -0,0 +1,27 @@
+---
+layout: default
+title: Create Virtual Environment
+nav_order: 1
+parent: Tutorials
+---
+## Install Python3 and Python Virtual Environment
+
+Either install python 3.10 or 3.11. Below example is to install python 3.11, however, to install and utilize python 3.10 just replace '11' with '10' in each instance below.  
+
+```shell
+$ sudo apt install python3.11 python3.11-dev python3.11-venv
+```
+
+## Create Virtual Environment (Python)
+
+First you need to decide where you would like you virtual environment to be stored.  Personally I use ```~/Documents/python3-venvs``` to store utility python environments. After creating the directory where you would like to store you python environments move into it and run the below command.  
+
+``` shell
+$ python3.11 -m venv nutri-matic-venv
+```
+
+Then source into that python environment.  
+
+```shell
+$ source ./nutri-matic-venv/bin/activate
+```
diff --git a/{{ cookiecutter.project_slug }}/_manual/tutorials/index.md b/{{ cookiecutter.project_slug }}/_manual/tutorials/index.md
@@ -5,3 +5,6 @@ nav_order: 1
 has_children: true
 ---
 ## {{ cookiecutter.project_name }} Tutorials
+
+* [Create Virtual Environment]({% raw %}{% link _manual/tutorials/create-virtual-env.md %}{% endraw %})  
+* [Nutri-Matic]({% raw %}{% link _manual/tutorials/nutri-matic.md %}{% endraw %})  
diff --git a/{{ cookiecutter.project_slug }}/_manual/tutorials/nutri-matic.md b/{{ cookiecutter.project_slug }}/_manual/tutorials/nutri-matic.md
@@ -0,0 +1,20 @@
+---
+layout: default
+title: Create Virtual Environment
+nav_order: 1
+parent: Tutorials
+---
+## Nutri-Matic Setup
+
+First clone the nutri-matic python utility.  This is needed to clone all jcook3701's, cookiecutter templates, with ```cookiecutter``` command.
+```shell
+$ git clone git@github.com:jcook3701/nutri-matic.git
+```
+
+Next, create a [virtual environment]({% raw %}{% link _manual/tutorials/create-virtual-env.md %}{% endraw %}) to store nutri-matic install. This is need to avoid installing packages directly to the system python instance.  
+
+Finally, install [Nutri-Matic](https://github.com/jcook3701/nutri-matic) from [pypi](https://pypi.org/project/nutri-matic/) repository.  
+
+```shell
+$ python -m pip install nutri-matic
+```
diff --git a/{{ cookiecutter.project_slug }}/index.md b/{{ cookiecutter.project_slug }}/index.md
@@ -4,9 +4,7 @@ title: {{ cookiecutter.project_name }}
 nav_order: 1
 description: {{ cookiecutter.description }}
 ---
-
-{% raw %}
-
+{%- raw %}
 {% include snippet_loader.html %}
 
 {% if site.carousel_images %}
@@ -21,5 +19,4 @@ If you enjoy this project, please consider buying me a coffee or making a code c
 ## Social Links
 
 {% include social-bar.html %}
-
 {% endraw %}
