docs: rename chapter 1 #567

.github/actions/check_milestone/action.yaml

@@ -76,7 +76,7 @@ runs:
       id: releasenotes
       shell: bash
       run: |
-        if [ -f "exampleSite/content/basics/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md" ]; then
+        if [ -f "exampleSite/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md" ]; then
           echo "file_exists=true" >> $GITHUB_OUTPUT
         else
           echo "file_exists=false" >> $GITHUB_OUTPUT

.github/actions/release_milestone/action.yaml

@@ -108,27 +108,27 @@ runs:
         GITHUB_TOKEN: ${{ inputs.github_token }}
         GREN_GITHUB_TOKEN: ${{ inputs.github_token }}
       run: |
-        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" %}}" > exampleSite/content/basics/releasenotes/${{ steps.majorvers.outputs.value }}/_index.en.md
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" %}}" > exampleSite/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/_index.en.md
 
     - name: Update releasenotes front matter
       uses: surahmansada/file-regex-replace@v1
       with:
         regex: '(\ntitle = "Version )\d+\.\d+("\n.*\nweight = -)\d+(\n)'
         replacement: "$1${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}.0$2${{ steps.minorvers.outputs.value }}$3"
-        include: exampleSite/content/basics/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md
+        include: exampleSite/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md
 
     - name: Update releasenotes heading
       uses: surahmansada/file-regex-replace@v1
       with:
         regex: '(.)[\n\r\s]*[\n\r]+##\s+.*?[\n\r][\n\r\s]*(.)'
         replacement: "$1\n\n## ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}.0 (${{ steps.date.outputs.time }}) {#${{ steps.majorvers.outputs.value }}-${{ steps.minorvers.outputs.value }}-0}\n\n$2"
-        include: exampleSite/content/basics/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md
+        include: exampleSite/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md
 
     - name: Generate piratish releasenotes
       shell: bash
       run: |
-        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n{{< piratify >}}" > exampleSite/content/basics/releasenotes/${{ steps.majorvers.outputs.value }}/_index.pir.md
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n{{< piratify >}}" > exampleSite/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/_index.pir.md
-        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n{{< piratify >}}" > exampleSite/content/basics/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.pir.md
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n{{< piratify >}}" > exampleSite/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.pir.md
 
     - name: Generate english changelogs
       shell: bash
@@ -137,23 +137,23 @@ runs:
         GITHUB_TOKEN: ${{ inputs.github_token }}
         GREN_GITHUB_TOKEN: ${{ inputs.github_token }}
       run: |
-        mkdir -p exampleSite/content/basics/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}
+        mkdir -p exampleSite/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}
-        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" %}}" > exampleSite/content/basics/changelog/${{ steps.majorvers.outputs.value }}/_index.en.md
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" %}}" > exampleSite/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/_index.en.md
-        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" reverse=\"true\" %}}" > exampleSite/content/basics/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/_index.en.md
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" reverse=\"true\" %}}" > exampleSite/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/_index.en.md
-        npx github-release-notes@0.17.1 changelog --generate --changelog-filename exampleSite/content/basics/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.en.md --tags "$MILESTONE"
+        npx github-release-notes@0.17.1 changelog --generate --changelog-filename exampleSite/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.en.md --tags "$MILESTONE"
 
     - name: Generate piratish changelogs
       shell: bash
       run: |
-        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n{{< piratify >}}" > exampleSite/content/basics/changelog/${{ steps.majorvers.outputs.value }}/_index.pir.md
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n{{< piratify >}}" > exampleSite/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/_index.pir.md
-        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n{{< piratify >}}" > exampleSite/content/basics/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/_index.pir.md
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n{{< piratify >}}" > exampleSite/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/_index.pir.md
-        echo -e "+++\n+++\n{{< piratify >}}" > exampleSite/content/basics/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.pir.md
+        echo -e "+++\n+++\n{{< piratify >}}" > exampleSite/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.pir.md
 
     - name: Read changelog
       id: changelog_docs
       uses: guibranco/github-file-reader-action-v2@latest
       with:
-        path: exampleSite/content/basics/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.en.md
+        path: exampleSite/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.en.md
 
     - name: Write changelog to CHANGELOG.md
       uses: surahmansada/file-regex-replace@v1
@@ -168,7 +168,7 @@ runs:
       with:
         value: ${{ steps.changelog_docs.outputs.contents }}
         regex: '(##\s+.*?[\n\r])[\n\r\s]*([\s\S]*)'
-        replacement: "[★ What's new in this version ★](https://mcshelby.github.io/hugo-theme-relearn/basics/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/)\n\n$2"
+        replacement: "[★ What's new in this version ★](https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/)\n\n$2"
 
     - name: Commit updates
       shell: bash

README.md

@@ -2,7 +2,7 @@
 
 A theme for [Hugo](https://gohugo.io/) designed for documentation.
 
-[★ What's new in the latest version ★](https://mcshelby.github.io/hugo-theme-relearn/basics/releasenotes)
+[★ What's new in the latest version ★](https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes)
 
 ![Image of the Relearn theme in light and dark mode on phone, tablet and desktop](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/hero.png)
 
@@ -64,11 +64,11 @@ The Relearn theme is an enhanced fork of the popular [Learn theme](https://githu
 
 ## Getting Started
 
-For a comprehensive guide on the theme's capabilities, please refer to the [official documentation](https://mcshelby.github.io/hugo-theme-relearn/basics/quickstart).
+For a comprehensive guide on the theme's capabilities, please refer to the [official documentation](https://mcshelby.github.io/hugo-theme-relearn/introduction/quickstart).
 
 ## Updates and Changes
 
-Visit the [What's New](https://mcshelby.github.io/hugo-theme-relearn/basics/releasenotes) page for feature highlights or the [detailed changelog](https://mcshelby.github.io/hugo-theme-relearn/basics/changelog) for a complete list of updates.
+Visit the [What's New](https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes) page for feature highlights or the [detailed changelog](https://mcshelby.github.io/hugo-theme-relearn/introduction/changelog) for a complete list of updates.
 
 ## Contributing
 

exampleSite/content/_index.en.md

@@ -4,7 +4,7 @@ title = "Hugo Relearn Theme"
 type = "home"
 [[cascade]]
 	[cascade._target]
-		path = "/basics/changelog/*/*/*"
+		path = "/introduction/changelog/*/*/*"
 	[cascade.params]
 		[cascade.params._build]
 			render = "never"

exampleSite/content/_index.pir.md

@@ -4,7 +4,7 @@ title = "Cap'n Hugo Relearrrn Theme"
 type = "home"
 [[cascade]]
 	[cascade._target]
-		path = "/basics/changelog/*/*/*"
+		path = "/introduction/changelog/*/*/*"
 	[cascade.params]
 		[cascade.params._build]
 			render = "never"

exampleSite/content/configuration/siteorganization/multilingual/_index.en.md

@@ -36,7 +36,7 @@ The theme supports a wide set of languages, also supporting languages written ri
 
 ## Basic Configuration
 
-This example will show you, how to convert your site created in the [Getting Started](basics/quickstart) section to be multilingual using [translation by file name](https://gohugo.io/content-management/multilingual/#translation-by-file-name). You can also use [translation by content directory](https://gohugo.io/content-management/multilingual/#translation-by-content-directory), but this is out of the scope of this documentation.
+This example will show you, how to convert your site created in the [Getting Started](introduction/quickstart) section to be multilingual using [translation by file name](https://gohugo.io/content-management/multilingual/#translation-by-file-name). You can also use [translation by content directory](https://gohugo.io/content-management/multilingual/#translation-by-content-directory), but this is out of the scope of this documentation.
 
 Define your languages in your `hugo.toml` file. For example with English and Piratish English website.
 

exampleSite/content/configuration/siteorganization/structure/_index.en.md

@@ -6,7 +6,7 @@ weight = 1
 
 ## Structure
 
-If you've followed the [Getting Started](basics/quickstart/) guide, you are resulting in a directory layout similar to this
+If you've followed the [Getting Started](introduction/quickstart/) guide, you are resulting in a directory layout similar to this
 
 ````plaintext
 ├── content
@@ -39,4 +39,4 @@ This makes it easy to customize the theme without having to edit files inside of
 > [!WARNING]
 > If you have cloned the theme repository and start editing files for your site in this clone, you're doing it wrong.
 >
-> Follow the [Getting Started](basics/quickstart/) guide.
+> Follow the [Getting Started](introduction/quickstart/) guide.

exampleSite/content/dev/contributing/_index.en.md

@@ -15,7 +15,7 @@ Stay close to the Hugo way.
 
 Don't use npm or any preprocessing, our contributors may not be front-end developers.
 
-Document new features in the exampleSite. This also contains entries to the [What's new](basics/releasenotes) page.
+Document new features in the exampleSite. This also contains entries to the [What's new](introduction/releasenotes) page.
 
 Don't break existing features if you don't have to.
 

exampleSite/content/introduction/_index.en.md

@@ -1,5 +1,5 @@
 +++
-title = "Basics"
+title = "Introduction"
 type = "chapter"
 weight = 1
 +++

exampleSite/content/introduction/_index.pir.md

@@ -1,5 +1,5 @@
 +++
-title = "Basics"
+title = "Introduction"
 type = "chapter"
 weight = 1
 +++