Skip to content

Commit 3e33f1b

Browse files
committed
feat(docs): Documentation updates.
1 parent eb168e2 commit 3e33f1b

9 files changed

Lines changed: 42 additions & 21 deletions

File tree

changelogs/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,10 @@ Feat 014 (#43)
147147

148148
- *(template)* Updates to template cookiecutter.json file.
149149
- *(links)* More link fixes along with a few configuration fixes to remove warnings.
150+
151+
### 🚀 Added
152+
153+
- *(links)* More links and general docs template updates.
150154
## [0.1.0] - 2025-12-05
151155

152156
### ⚙️ Miscellaneous

changelogs/releases/v0.1.1.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,3 +147,7 @@ Feat 014 (#43)
147147

148148
- *(template)* Updates to template cookiecutter.json file.
149149
- *(links)* More link fixes along with a few configuration fixes to remove warnings.
150+
151+
### 🚀 Added
152+
153+
- *(links)* More links and general docs template updates.

cookiecutter.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
"ga_tracking": "G-C7PWLWSHB9",
3333
"github_org": null,
3434
"github_username": "jcook3701",
35+
"github_io": "https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.project_slug }}",
3536
"twitter_username": "",
3637
"linkedin_usercode": "jared-cook-b3585a114",
3738
"buymeacoffee_username": "jcook3701",

docs/jekyll/Makefile

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,7 @@ help:
8686
$(AT)echo " version: $(PACKAGE_VERSION)"
8787
$(AT)echo ""
8888
$(AT)echo "Usage:"
89-
$(AT)echo " make ruby-inst\
90-
91-
92-
93-
fddjfsal;dsjfklas;jdklf;JINJA_FILE_LIST
94-
sall Installs Gemfile packages."
89+
$(AT)echo " make ruby-install Installs Gemfile packages."
9590
$(AT)echo " make build Generate Jekyll documentation"
9691
$(AT)echo " make run Serve Jekyll site locally"
9792
$(AT)echo " make clean Clean Jekyll build artifacts"

{{ cookiecutter.project_slug }}/README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# {{ site.title }}
22

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

55
__Author:__ {{ site.author }}
66
__Version:__ {{ site.version }}
@@ -19,16 +19,23 @@ __CI/CD Check List:__
1919

2020
***
2121

22-
## Usage Examples
22+
## Getting Started
23+
* [Get {{ cookiecutter.project_name}}]
24+
* [Installation guides]
2325

24-
## Advance Examples
26+
## Documentation
27+
The {{ cookiecutter.project_name }} documentation is available at [docs]({{ site.github_io_url }})
2528

26-
## Development Strategy
29+
## Contributing
30+
If you're interested in contributing to the {{ cookiecutter.project_name }} project:
31+
* Start by reading the [contributing guide]({{ site.github_io_url }}/developer-resources/contribute.md).
32+
* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/contribute/developer-guide.md).
33+
* Look through our [style guide]({{ site.github_io_url }}/contribute/style-guides/index.md).
2734

2835
## License
2936
{{ cookiecutter.copyright }}
3037

3138
This project is licensed under the __{{ cookiecutter.license }} License__.
32-
See the [LICENSE](LICENSE) file for the full license text.
39+
See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text.
3340

3441
SPDX-License-Identifier: {{ cookiecutter.license }}

{{ cookiecutter.project_slug }}/_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ remote_theme: "{{ cookiecutter.theme }}"
99
ga_tracking: "{{ cookiecutter.ga_tracking }}"
1010

1111
repo_url: "{{ cookiecutter.repo_url }}"
12-
repo_blob: "{{cookiecutter.repo_url }}/blob/{{ cookiecutter._checkout }}/"
13-
github_io_url: "https://{{ cookiecutter.github_username }}.github.io/"
12+
repo_blob: "{{cookiecutter.repo_url }}/blob/{{ cookiecutter._checkout }}"
13+
github_io_url: "{{ cookiecutter.github_io }}"
1414
repository: "{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}"
1515

1616
# Specifies the site's subpath for correct URL generation

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ $ make format-check
4141
$ make format-fix
4242
```
4343

44-
### 🔍 Linting (jinja2-cli, ruff, tomllint, & yaml-lint)
44+
### 🔍 Linting (djlint, ruff, tomllint, & yaml-lint)
4545

4646
``` shell
4747
$ make lint-check

{{ cookiecutter.project_slug }}/_manual/contribute/index.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,13 @@ has_children: true
99
We're excited that you're considering making a contribution to the {{ cookiecutter.project_name }} project! This is the place to find guides for contributors to our open-source project.
1010

1111
These are some good resources to explore for developers:
12-
{% raw %}
13-
[Create a pull request]({% link _manual/contribute/create-pull-request.md %})
14-
[Create a feature request]({% link _manual/contribute/create-feature-request.md %})
15-
[Developer guide]({% link _manual/contribute/developer-guide.md %})
16-
[Merge a pull request]({% link _manual/contribute/merge-pull-request.md %})
17-
{% endraw %}
18-
Find style guides for the {{ cookiecutter.project_name }} software project:
12+
13+
* [Create a pull request]({% raw %}{% link _manual/contribute/create-pull-request.md %}{% endraw %})
14+
* [Create a feature request]({% raw %}{% link _manual/contribute/create-feature-request.md %}{% endraw %})
15+
* [Developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %})
16+
* [Merge a pull request]({% raw %}{% link _manual/contribute/merge-pull-request.md %}{% endraw %})
17+
18+
Find [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}) for the {{ cookiecutter.project_name }} software project:
19+
* [Python]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}) style guide.
20+
* [Typescript]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}) style guide.
21+
* [YAML]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}) style guide.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
layout: default
3+
title: Getting Started
4+
nav_order: 1
5+
parent: Introduction
6+
---
7+
## Getting started with {{ cookiecutter.project_name }}

0 commit comments

Comments
 (0)