The base commit

Author: habedi

.editorconfig

@@ -1,5 +1,3 @@
-# EditorConfig is awesome: https://EditorConfig.org
-
 # Top-most EditorConfig file
 root = true
 
@@ -29,4 +27,6 @@ indent_size = 2
 [*.{yml,yaml}]
 indent_size = 2
 
-
+# Python files
+[*.py]
+max_line_length = 100

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [ habedi ]

.github/workflows/codecov.yml

@@ -0,0 +1,41 @@
+name: Publish API Documentation
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install Zig
+        uses: goto-bus-stop/setup-zig@v2
+        with:
+          version: '0.14.1'
+
+      - name: Install System Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y make
+
+      - name: Generate Documentation
+        run: make docs
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/api
+          publish_branch: gh-pages
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          commit_message: "docs: Deploy documentation from ${{ github.sha }}"

.github/workflows/docs.yml

@@ -1,29 +1,38 @@
-name: Run Linters
+name: Run Linter Checks
 
 on:
-  workflow_dispatch:
-  pull_request:
+  push:
     branches:
       - main
     tags:
       - 'v*'
 
+  pull_request:
+    branches:
+      - main
+
+  workflow_dispatch:
+
 permissions:
   contents: read
 
 jobs:
-  lint:
+  lints:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
 
+      - name: Install Zig
+        uses: goto-bus-stop/setup-zig@v2
+        with:
+          version: '0.14.1'
+
       - name: Install Dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y make
-          make install-deps
 
       - name: Run Linters
         run: make lint

.github/workflows/lints.yml

@@ -1,29 +1,38 @@
-name: Run Test
+name: Run Tests
 
 on:
-  workflow_dispatch:
-  pull_request:
+  push:
     branches:
       - main
     tags:
       - 'v*'
 
+  pull_request:
+    branches:
+      - main
+
+  workflow_dispatch:
+
 permissions:
   contents: read
 
 jobs:
-  build:
+  tests:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
+      - name: Install Zig
+        uses: goto-bus-stop/setup-zig@v2
+        with:
+          version: '0.14.1'
+
       - name: Install Dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y make
-          make install-deps
 
       - name: Run the Tests
         run: make test

.github/workflows/tests.yml

@@ -91,8 +91,9 @@ temp/
 
 # Dependency lock files (optional)
 poetry.lock
+uv.lock
 
 # Additional files and directories to ignore (put below)
-docs/api/
 *_output.txt
-
+public/
+site/

.gitignore

@@ -0,0 +1,41 @@
+default_stages: [ pre-push ]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        args: [ --markdown-linebreak-ext=md ]
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      - id: detect-private-key
+      - id: check-yaml
+      - id: check-toml
+      - id: check-json
+      - id: check-docstring-first
+      - id: pretty-format-json
+        args: [ --autofix, --no-sort-keys ]
+
+  - repo: local
+    hooks:
+      - id: format
+        name: Format Code
+        entry: make format
+        language: system
+        pass_filenames: false
+        stages: [ pre-commit ]
+
+      - id: lint
+        name: Check Code Style
+        entry: make lint
+        language: system
+        pass_filenames: false
+        stages: [ pre-commit ]
+
+      - id: test
+        name: Run Tests
+        entry: make test
+        language: system
+        pass_filenames: false

.pre-commit-config.yaml

@@ -1,3 +1,3 @@
-# Code of Conduct
+## Code of Conduct
 
 We adhere to the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) version 2.1.

CODE_OF_CONDUCT.md

@@ -1,21 +1,21 @@
-# Contribution Guidelines
+## Contribution Guidelines
 
 Thank you for considering contributing to this project!
 Contributions are always welcome and appreciated.
 
-## How to Contribute
+### How to Contribute
 
-Please check the [issue tracker](https://github.com/habedi/template-zig-project/issues) to see if there is an issue you
+Please check the [issue tracker](https://github.com/CogitatorTech/helium/issues) to see if there is an issue you
 would like to work on or if it has already been resolved.
 
-### Reporting Bugs
+#### Reporting Bugs
 
-1. Open an issue on the [issue tracker](https://github.com/habedi/template-zig-project/issues).
+1. Open an issue on the [issue tracker](https://github.com/CogitatorTech/helium/issues).
 2. Include information such as steps to reproduce the observed behavior and relevant logs or screenshots.
 
-### Suggesting Features
+#### Suggesting Features
 
-1. Open an issue on the [issue tracker](https://github.com/habedi/template-zig-project/issues).
+1. Open an issue on the [issue tracker](https://github.com/CogitatorTech/helium/issues).
 2. Provide details about the feature, its purpose, and potential implementation ideas.
 
 ## Submitting Pull Requests
@@ -26,9 +26,9 @@ would like to work on or if it has already been resolved.
 > [!IMPORTANT]
 > It's assumed that by submitting a pull request, you agree to license your contributions under the project's license.
 
-## Development Workflow
+### Development Workflow
 
-### Prerequisites
+#### Prerequisites
 
 Install GNU Make on your system if it's not already installed.
 
@@ -39,22 +39,22 @@ sudo apt-get install make
 
 - Use the `make install-deps` command to install the development dependencies.
 
-### Code Style
+#### Code Style
 
 - Use the `make format` command to format the code.
 
-### Running Tests
+#### Running Tests
 
 - Use the `make test` command to run the tests.
 
-### Running Linters
+#### Running Linters
 
 - Use the `make lint` command to run the linters.
 
-### See Available Commands
+#### See Available Commands
 
 - Run `make help` to see all available commands for managing different tasks.
 
-## Code of Conduct
+### Code of Conduct
 
-We adhere to the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) version 2.1.
+We adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md).