feat: add comments, and improve tooling description

Author: tolstenko

.github/workflows/documentation.yaml

@@ -29,7 +29,7 @@ jobs:
       - name: Install dependencies
         run: |
           apt install -y doxygen gource libgs-dev
-          pip3 install jinja2 Pygments mkdocs-material mkdocs mkdocs-same-dir mkdocs-minify-plugin mkdocs-redirects mkdocs-exclude
+          pip3 install jinja2 Pygments mkdocs-material mkdocs mkdocs-same-dir mkdocs-minify-plugin mkdocs-redirects mkdocs-exclude mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-git-authors-plugin
           npm install 
 
       - name: Configure

.gitignore

@@ -41,3 +41,4 @@ site/
 # caches
 node_modules/
 package-lock.json
+.cache

README.md

@@ -5,7 +5,6 @@ time for you to revisit them.
 - If you just want to read use the [pre-rendered documentation here](https://courses.tolstenko.net) the examples will work better there.
 - If you want to go deep and propose changes to repo, use the [github repo](https://github.com/InfiniBrains/Awesome-GameDev-Resources).
 
-
 # Badges
 
 CI: [![Documentation](https://github.com/InfiniBrains/Awesome-GameDev-Resources/actions/workflows/documentation.yaml/badge.svg)](https://github.com/InfiniBrains/Awesome-GameDev-Resources/actions/workflows/documentation.yaml)
@@ -73,3 +72,5 @@ For every type of style, I try to give a bit of insights:
     - I usually follow this strategy on advanced classes;
 - Demonstrator: explain and show things to students;
     - I usully provide a stream of references or even create my own content to show them how to do things;
+
+

intro/01-introduction/README.md

@@ -1,3 +1,6 @@
+---
+comments: true
+---
 # Reasons why you should learn how to program with C++
 
 Before we start, this repository aims to be practical, and I highly incentive you to look for other references. I want to add this another [awesome repository](https://github.com/federico-busato/Modern-CPP-Programming/) it holds an awesome compilation of modern C++ concepts.

intro/02-tooling/README.md

@@ -155,6 +155,7 @@ Keep in mind that it is a good practice to choose descriptive and meaningful nam
 
 It is also important to note that C++ has some naming conventions that are commonly followed by programmers. For example, it is common to use camelCase or snake_case to separate words in a variable name, and to use all lowercase letters for variables that are local to a function and all uppercase letters for constants.
 
+
 ## Variable declaration
 
 Variable declaration in C++ follows this pattern.

intro/03-datatypes/README.md

@@ -1,6 +1,7 @@
 site_name: Awesome GameDev Resources
 site_url: https://courses.tolstenko.net
 repo_url: https://github.com/InfiniBrains/Awesome-GameDev-Resources
+repo_name: InfiniBrains/Awesome-GameDev-Resources
 
 nav:
   - Home: README.md
@@ -44,23 +45,24 @@ docs_dir: .
 
 theme:
   name: material
+  custom_dir: overrides
   features:
-    # - announce.dismiss
+    - announce.dismiss
     - content.action.edit
     - content.action.view
     - content.code.annotate
     - content.code.copy
-    - content.tabs.link
+    # - content.tabs.link
     - content.tooltips
     # - header.autohide
-    - navigation.expand
+    # - navigation.expand
     - navigation.footer
     - navigation.indexes
-    # - navigation.instant
-    # - navigation.prune
+    - navigation.instant
+    - navigation.prune
     - navigation.sections
     - navigation.tabs
-#    - navigation.tabs.sticky
+    - navigation.tabs.sticky
     - navigation.top
     - navigation.tracking
     - search.highlight
@@ -104,7 +106,8 @@ theme:
     text: Roboto
     code: Roboto Mono
 #  favicon: assets/favicon.png
-#  icon:
+  icon:
+    repo: fontawesome/brands/git-alt
 #    logo: logo
 
 edit_uri: blob/main/
@@ -138,10 +141,10 @@ markdown_extensions:
       anchor_linenums: true
   - pymdownx.inlinehilite
   - pymdownx.keys
-#  - pymdownx.magiclink:
-#      repo_url_shorthand: true
-#      user: squidfunk
-#      repo: mkdocs-material
+  - pymdownx.magiclink:
+      repo_url_shorthand: true
+      user: InfiniBrains
+      repo: Awesome-GameDev-Resources
   - pymdownx.mark
   - pymdownx.smartsymbols
   - pymdownx.superfences:
@@ -156,20 +159,46 @@ markdown_extensions:
   - pymdownx.tilde
 
 plugins:
+  - git-revision-date-localized:
+      enable_creation_date: true
+#  - git-committers:
+#      repository: InfiniBrains/Awesome-GameDev-Resources
+#      branch: main
+#  - git-authors
   - same-dir
   - search:
       separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
-  - minify
+  - minify:
+      minify_html: true
+#  - optimize
   - exclude:
       glob:
         - node_modules/*
         - buildDocs/*
         - cmake-build-debug/*
+        - .cache
 
 extra:
+  generator: false
+  annotate:
+    json: [ .s2 ]
   analytics:
     provider: google
     property: G-347541715
+    feedback:
+      title: Was this page helpful?
+      ratings:
+        - icon: material/emoticon-happy-outline
+          name: This page was helpful
+          data: 1
+          note: >-
+            Thanks for your feedback!
+        - icon: material/emoticon-sad-outline
+          name: This page could be improved
+          data: 0
+          note: >-
+            Thanks for your feedback! Help us improve this page by
+            using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/InfiniBrains
@@ -180,4 +209,4 @@ extra:
 #    - icon: fontawesome/brands/python
 #      link: https://pypi.org/project/mkdocs-material/
 #    - icon: fontawesome/brands/twitter
-#      link: https://twitter.com/squidfunk
+#      link: https://twitter.com/squidfunk

mkdocs.yml

@@ -0,0 +1,48 @@
+
+<h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
+<!-- Insert generated snippet here -->
+<script src="https://giscus.app/client.js"
+        data-repo="InfiniBrains/Awesome-GameDev-Resources"
+        data-repo-id="R_kgDOIpptxQ"
+        data-category="General"
+        data-category-id="DIC_kwDOIpptxc4CTLTu"
+        data-mapping="pathname"
+        data-strict="0"
+        data-reactions-enabled="1"
+        data-emit-metadata="1"
+        data-input-position="bottom"
+        data-theme="preferred_color_scheme"
+        data-lang="en"
+        data-loading="lazy"
+        crossorigin="anonymous"
+        async>
+</script>
+<!-- Synchronize Giscus theme with palette -->
+<script>
+    var giscus = document.querySelector("script[src*=giscus]")
+
+    /* Set palette on initial load */
+    var palette = __md_get("__palette")
+    if (palette && typeof palette.color === "object") {
+        var theme = palette.color.scheme === "slate" ? "dark" : "light"
+        giscus.setAttribute("data-theme", theme)
+    }
+
+    /* Register event handlers after documented loaded */
+    document.addEventListener("DOMContentLoaded", function() {
+        var ref = document.querySelector("[data-md-component=palette]")
+        ref.addEventListener("change", function() {
+            var palette = __md_get("__palette")
+            if (palette && typeof palette.color === "object") {
+                var theme = palette.color.scheme === "slate" ? "dark" : "light"
+
+                /* Instruct Giscus to change theme */
+                var frame = document.querySelector(".giscus-frame")
+                frame.contentWindow.postMessage(
+                    { giscus: { setConfig: { theme } } },
+                    "https://giscus.app"
+                )
+            }
+        })
+    })
+</script>