[ docs ] Add Tutorials with AI-generated content according to https://diataxis.fr/tutorials/

Author: GulinSS

.editorconfig

@@ -48,3 +48,18 @@ max_line_length = off
 
 [*.py]
 indent_size = 4
+
+# See: https://stackoverflow.com/a/40348831/2572373
+[**{.build,docs/build,linters/build}**]
+charset = unset
+end_of_line = unset
+insert_final_newline = unset
+trim_trailing_whitespace = unset
+indent_style = unset
+indent_size = unset
+max_line_length = unset
+
+# Auto-generated file
+[.idrisCommit]
+insert_final_newline = unset
+

.github/workflows/ci-super-linter.yml

@@ -40,20 +40,13 @@ jobs:
           fetch-depth: 0
           persist-credentials: false # https://docs.zizmor.sh/audits/#artipacked
 
+      - name: Load super-linter configuration
+        # Use grep inverse matching to exclude eventual comments in the .env file
+        # because the GitHub Actions command to set environment variables doesn't
+        # support comments.
+        run: grep -v '^#' .github/linters/super-linter.env >> "$GITHUB_ENV"
+
       - name: Lint Code Base
         uses: super-linter/super-linter/slim@v8
         env:
-          DEFAULT_BRANCH: master
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          IGNORE_GENERATED_FILES: true
-          SAVE_SUPER_LINTER_SUMMARY: true # Required for generating linting reports in PR
-
-          VALIDATE_PYTHON_BLACK: false # Avoid conflict: Ruff is preferred
-          VALIDATE_GIT_COMMITLINT: false
-
-          VALIDATE_MARKDOWN_PRETTIER: false # We use markdownlint
-          VALIDATE_YAML_PRETTIER: false # We use yamllint
-
-          # Disable Biome
-          VALIDATE_BIOME_FORMAT: false
-          VALIDATE_BIOME_LINT: false

.linters/super-linter-fix.ipkg

@@ -0,0 +1,3 @@
+package super-linter-fix
+
+prebuild = "FIX_MARKDOWN=true FIX_NATURAL_LANGUAGE=true FIX_SPELL_CODESPELL=true ./super-linter.sh"

.linters/super-linter-local.env

@@ -0,0 +1,2 @@
+# Disable stuff which may not work for local run
+VALIDATE_CHECKOV=false

.linters/super-linter-run.ipkg

@@ -0,0 +1,3 @@
+package super-linter-run
+
+prebuild = "./super-linter.sh"

.linters/super-linter.env

@@ -0,0 +1,17 @@
+DEFAULT_BRANCH=master
+IGNORE_GENERATED_FILES=true
+# Required for generating linting reports in PR
+SAVE_SUPER_LINTER_SUMMARY=true
+
+# Avoid conflict: Ruff is preferred
+VALIDATE_GIT_COMMITLINT=false
+VALIDATE_PYTHON_BLACK=false
+
+# We use markdownlint
+VALIDATE_MARKDOWN_PRETTIER=false
+# We use yamllint
+VALIDATE_YAML_PRETTIER=false
+
+# Disable Biome
+VALIDATE_BIOME_FORMAT=false
+VALIDATE_BIOME_LINT=false

.linters/super-linter.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# See: https://github.com/super-linter/super-linter/blob/dd82ec5c927bff0fecc98865b0be8aa6ef849001/docs/run-linter-locally.md
+docker run --platform linux/amd64 \
+  --env-file "$(pwd)/../.github/linters/super-linter.env" \
+  --env-file "$(pwd)/../.github/linters/super-linter-local.env" \
+  -e LOG_LEVEL=NOTICE \
+  -e RUN_LOCAL=true \
+  -e FIX_MARKDOWN="${FIX_MARKDOWN:-false}" \
+  -e FIX_NATURAL_LANGUAGE="${FIX_NATURAL_LANGUAGE:-false}" \
+  -e FIX_SPELL_CODESPELL="${FIX_SPELL_CODESPELL:-false}" \
+  -v "$(pwd)/../":/tmp/lint \
+  ghcr.io/super-linter/super-linter:latest

docs/source/tutorials.rst

@@ -14,6 +14,20 @@ You can read more in the `original framework <https://diataxis.fr/tutorials/>`_
   :maxdepth: 1
   :caption: Choose what to learn
 
-  tutorials/test-function
-  tutorials/generators
-  tutorials/derivation
+  tutorials/t00-installation-and-setup
+  tutorials/t01-generator-monad
+  tutorials/t02-handling-emptiness
+  tutorials/t03-measuring-test-coverage
+  tutorials/t04-automatic-generator-derivation
+  tutorials/t05-derivegen-signatures
+  tutorials/t06-mixing-manual-and-automatic
+  tutorials/t07-beyond-fuel
+  tutorials/t08-generating-gadts-with-proofs
+  tutorials/t09-toy-example
+
+.. toctree::
+  :maxdepth: 1
+  :caption: Enjoy your curiosity
+
+  tutorials/t10-derivation-tuning
+  tutorials/t11-under-the-hood-a-derivegen-like-macro