{feat) docs

Author: F.

.github/workflows/documentation.yml

@@ -0,0 +1,51 @@
+---
+
+name: Documentation
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/documentation.yml'
+      - 'mkdocs.yml'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/documentation.yml'
+      - 'mkdocs.yml'
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          cache: pip
+
+      - name: Install dependencies
+        run: |
+          pip install mkdocs-material
+          pip install mkdocs-git-revision-date-localized-plugin
+          pip install mkdocs-minify-plugin
+
+      - name: Deploy Documentation
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          mkdocs gh-deploy --force
+
+      - name: Build Documentation
+        if: github.event_name == 'pull_request'
+        run: mkdocs build

.pre-commit-config.yaml

@@ -12,14 +12,15 @@ repos:
       - id: debug-statements
       - id: check-yaml
         files: .*\.(yaml|yml)$
+        exclude: docs/*
         args: [--allow-multiple-documents]
   - repo: https://github.com/adrienverge/yamllint.git
     rev: v1.35.1
     hooks:
       - id: yamllint
         files: \.(yaml|yml)$
         types: [file, yaml]
-        entry: yamllint --strict -f parsable
+        entry: yamllint -c ./.yamllint.yaml --strict -f parsable
   - repo: local
     hooks:
       - id: golangci-lint

.vscode/settings.json

@@ -1,16 +1,19 @@
 {
     "makefile.configureOnOpen": false,
     "cSpell.words": [
+        "arithmatex",
         "asasalint",
         "asciicheck",
         "azuretools",
         "benchmem",
+        "betterem",
         "bidichk",
         "bodyclose",
         "canonicalheader",
         "containedctx",
         "contextcheck",
         "copyloopvar",
+        "Cosentino",
         "cyclop",
         "daixiang",
         "decorder",
@@ -28,8 +31,10 @@
         "ewrap",
         "fatcontext",
         "fieldalignment",
+        "fontawesome",
         "forbidigo",
         "forcetypeassert",
+        "Francesco",
         "funlen",
         "ginkgolinter",
         "GITVERSION",
@@ -61,13 +66,17 @@
         "importas",
         "inamedparam",
         "ineffassign",
+        "inlinehilite",
         "interfacebloat",
         "intrange",
         "ireturn",
+        "linenums",
         "loggercheck",
         "logrus",
+        "magiclink",
         "maintidx",
         "makezero",
+        "mkdocs",
         "multierror",
         "musttag",
         "mvdan",
@@ -90,15 +99,20 @@
         "promlinter",
         "proto",
         "protogetter",
+        "pygments",
+        "pymdownx",
         "rowserrcheck",
         "sirupsen",
         "sloglint",
+        "smartsymbols",
         "spancheck",
         "sqlclosecheck",
         "staticcheck",
         "stdlib",
         "stretchr",
         "stylecheck",
+        "superfences",
+        "tasklist",
         "tenv",
         "testableexamples",
         "testifylint",

.yamllint

@@ -251,15 +251,9 @@ The package is designed with performance in mind:
 ## Project Structure
 
 ```txt
-├── cmd/ # Main applications
-│   └── app/ # Your application
-│       └── main.go # Application entry point
 ├── internal/ # Private code
-│   ├── pkg/ # Internal packages
-│   └── app/ # Application specific code
-├── pkg/ # Public libraries
-├── api/ # API contracts (proto files, OpenAPI specs)
-├── configs/ # Configuration files
+│   └── logger/ # Application specific code
+├── pkg/ # Public libraries)
 ├── scripts/ # Scripts for development
 ├── test/ # Additional test files
 └── docs/ # Documentation