Skip to content

Commit 3c5e58a

Browse files
committed
fix(links): Major fixes for documentation links.
1 parent 13bc6f7 commit 3c5e58a

8 files changed

Lines changed: 42 additions & 20 deletions

File tree

changelogs/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,10 @@ Feat 016 (#47)
179179

180180
- *(template)* Updates to template cookiecutter.json file.
181181
- *(configuration)* I think this should fix the last of the problems with main showing up where master should for this repository.
182+
183+
### 🚀 Added
184+
185+
- *(docs)* Updates to setup, getting-started, and initial tutorials.
182186
## [0.1.0] - 2025-12-05
183187

184188
### ⚙️ Miscellaneous

changelogs/releases/v0.1.1.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,3 +179,7 @@ Feat 016 (#47)
179179

180180
- *(template)* Updates to template cookiecutter.json file.
181181
- *(configuration)* I think this should fix the last of the problems with main showing up where master should for this repository.
182+
183+
### 🚀 Added
184+
185+
- *(docs)* Updates to setup, getting-started, and initial tutorials.

{{ cookiecutter.project_slug }}/_manual/contribute/create-feature-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ We're excited to hear your ideas! Before you submit a feature request, consider
1717

1818
## Your first feature request
1919

20-
When you're ready to submit a feature request, use the [feature request template]({{ cookiecutter.repo_url }}/issues/new?template=02-feature_request.md). The template has three sections that help maintainers understand what you need and why.
20+
When you're ready to submit a feature request, use the [feature request template]({{ cookiecutter.repo_url }}/issues/new?template=02-feature-request.yml). The template has three sections that help maintainers understand what you need and why.
2121

2222
<!-- TODO: Put together an example feature request.
2323

{{ cookiecutter.project_slug }}/_manual/contribute/create-pull-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ Every contribution to {{ cookiecutter.project_name }}'s software begins with a [
1313

1414
We know you're excited to create your first pull request. Before we get started, read these resources first:
1515

16-
- Get started [contributing to {{ cookiecutter.project_name }}]({% raw %}{{ site.repo_url }}{% endraw %}/CONTRIBUTING.md).
16+
- Get started [contributing to {{ cookiecutter.project_name }}]({% raw %}{{ site.repo_blob }}{% endraw %}/.github/CONTRIBUTING.md).
1717
- Make sure your code follows the relevant [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}).
1818
- It's recommended you [set up precommit hooks]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %}) to auto-format when you commit.

{{ cookiecutter.project_slug }}/_manual/contribute/git-commit-message.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ parent: Contribute
66
---
77
## Git Commit Message Format Guide
88

9-
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.
9+
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/).
1010

1111
__example:__
1212

{{ cookiecutter.project_slug }}/_manual/developer-resources/contribute.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ This page lists resources for developers who want to contribute to the {{ cookie
1313
### Contribute code to {{ cookiecutter.project_name }}
1414

1515
* [Developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %})
16-
* [Create a pull request] walks you through preparing a clear, descriptive pull request.
16+
* [Create a pull request]({% raw %}{% link _manual/contribute/create-pull-request.md %}{% endraw %}) walks you through preparing a clear, descriptive pull request.
1717
* [Create a feature request]({% raw %}{% link _manual/contribute/create-feature-request.md %}{% endraw %})
1818
* [Merge a pull request]({% raw %}{% link _manual/contribute/merge-pull-request.md %}{% endraw %})
19-
* Browse all [issues]({{ cookiecutter.repo_url }}/issues/new) to find a good first task. <!-- You can also filter by [help wanted](). -->
19+
* Browse all [issues]({{ cookiecutter.repo_url }}/issues) to find a good first task. <!-- You can also filter by [help wanted](). -->
2020

2121
### Contribute without code
2222

@@ -26,7 +26,8 @@ This page lists resources for developers who want to contribute to the {{ cookie
2626

2727
### Best practices and style
2828

29-
Our [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}) outline {{ cookiecutter.project_name }} style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding!
30-
* [Python style guide]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}).
31-
* [Typescript style guide]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}).
32-
* [YAML style guide]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}).
29+
Our [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}) outline {{ cookiecutter.project_name }} style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding!
30+
31+
* [Python style guide]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}).
32+
* [Typescript style guide]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}).
33+
* [YAML style guide]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}).

{{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,26 @@ parent: Introduction
99
1. [Requirements]({% raw %}{% link _manual/setup-guide/requirements.md %}{% endraw %}) include python3, Nutri-Matic (docs & hooks), rust (rustup), and git-cliff (changelogs).
1010
* Python3 Packages
1111
1. [cookiecutter](https://github.com/cookiecutter/cookiecutter) is required to utilize templates from github.
12-
2. Nutri-Matic is required to be sourced in python environment for template cookiecutter hooks to work.
12+
2. [Nutri-Matic](https://github.com/jcook3701/nutri-matic) is required to be sourced in python environment for template cookiecutter hooks to work.
1313

1414
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.
1515

16-
__Example:__ Bash script can be copied and pasted into a shell file. Then, used to begin generating new projects.
16+
### Examples
17+
18+
Bash script can be copied and pasted into a shell file. Then, used to begin generating new projects.
19+
1720
__Template Options:__
18-
* cookiecutter-cookiecutter to generate new cookiecutter template projects.
19-
* python3-cookiecutter to generate python3 projects.
20-
* ansible-cookiecutter to generate ansible galaxy project.
21+
* [cookiecutter-cookiecutter](https://github.com/jcook3701/cookiecutter-cookiecutter) to generate new cookiecutter template projects.
22+
* [python3-cookiecutter](https://github.com/jcook3701/python3-cookiecutter) to generate python3 projects.
23+
* [ansible-cookiecutter](https://github.com/jcook3701/ansible-galaxy-cookiecutter) to generate ansible galaxy project.
24+
<!-- TODO: The below repositories are planned future work. -->
2125
<!-- * ansible-config-cookiecutter to generate local ansible configuration. -->
22-
* typescript-cookiecutter to generate typescript project.
26+
<!-- * [typescript-cookiecutter](https://github.com/jcook3701/typescript-cookiecutter) to generate typescript project. -->
2327
<!-- * chrome-extension-cookiecutter to generate google chrome extension project. -->
28+
<!-- * [ROS2-cookiecutter](https://github.com/jcook3701/ROS2-cookiecutter) to generate Robot2 Operating System Package. -->
29+
<!-- TODO: Figure out how I want to display documentation templates. -->
30+
<!-- * [github-docs-cookiecutter](https://github.com/jcook3701/github-docs-cookiecutter) to add documentation to a templates [github pages](https://docs.github.com/en/pages). -->
31+
<!-- * [sphinx-docs-cookiecutter](https://github.com/jcook3701/sphinx-cookiecutter) to add python documentation generated by [Sphinx](https://github.com/sphinx-doc/sphinx). -->
2432

2533
```shell
2634
#!/bin/bash
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
---
22
layout: default
3-
title: Create Virtual Environment
3+
title: "Nutri-Matic"
44
nav_order: 1
55
parent: Tutorials
66
---
77
## Nutri-Matic Setup
88

9-
First clone the nutri-matic python utility. This is needed to clone all jcook3701's, cookiecutter templates, with ```cookiecutter``` command.
9+
First clone the [Nutri-Matic](https://github.com/jcook3701/nutri-matic) python utility. This is needed to clone all [jcook3701's](https://github.com/jcook3701), cookiecutter templates, with the ```cookiecutter``` command.
10+
1011
```shell
1112
$ git clone git@github.com:jcook3701/nutri-matic.git
1213
```
1314

14-
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.
15+
Next, move into the newly cloned directory, ```cd nutri-matic``` . Then utilize the [developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %}) process and run ```make python-install``` to create a python virtual environment stored within the, ```.venv```, folder. This ensures the latest version of nutri-matic code and is very helpful for development on any of the template repositories.
1516

16-
Finally, install [Nutri-Matic](https://github.com/jcook3701/nutri-matic) from [pypi](https://pypi.org/project/nutri-matic/) repository.
17+
Finally, source Nutri-Matic's created virtual environment with the directory, ```.venv```, and begin generating templates.
1718

1819
```shell
19-
$ python -m pip install nutri-matic
20+
$ source .venv/bin/active
2021
```
22+
23+
The Nutri-Matic package is responsible for managing all [jcook3701's](https://github.com/jcook3701) cookiecutter template hooks and build features.
24+
25+
After the environment is sourced and other project dependencies are installed; templates should be able to be generated using the commands found in our [getting started]({% raw %}{% link _manual/introduction/getting-started.md %}{% endraw %}) guide.

0 commit comments

Comments
 (0)