initialise docs

Author: samiralavi

.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+name: Docs latest and released versions
+
+on:
+  push:
+    branches:
+      - "v*.*"
+      - main
+
+jobs:
+  build_docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    name: Build and Deploy Job
+    steps:
+      - uses: actions/checkout@latest
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@latest
+        with:
+          python-version: 3.12
+
+      - name: Install poetry
+        uses: abatilo/actions-poetry@latest
+        with:
+          poetry-version: latest
+
+      - name: Install packages
+        run: |
+          poetry install
+
+      - name: Configure Git user
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+
+      - name: Extract branch name
+        shell: bash
+        run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+        id: extract_branch
+
+      - name: Build docs
+        run: |
+          poetry run mike deploy --push ${{ steps.extract_branch.outputs.branch }}

.github/workflows/semantic_pr_title.yaml

@@ -0,0 +1,20 @@
+name: Check Pull Request Title
+
+on:
+  pull_request:
+    branches: [main, feat/*]
+
+jobs:
+  semantic_pull_request:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    steps:
+      - name: Check PR title uses conventional commit spec
+        uses: amannn/action-semantic-pull-request@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          types: |
+            fix
+            feat

.gitignore

@@ -0,0 +1 @@
+.venv

docs/index.md

@@ -0,0 +1 @@
+# EmbedIDS, Modern Intrusion Detection System (IDS) for Embedded Systems

mkdocs.yml

@@ -0,0 +1,64 @@
+site_name: EmbedIDS, Modern Intrusion Detection System (IDS) for Embedded Systems
+site_author: Seyed Amir Alavi
+site_url: https://embedids.samiralavi.io/
+repo_name: samiralavi/embedids
+docs_dir: "docs"
+theme:
+  name: material
+  language: en
+  icon:
+    logo: material/contacts
+  favicon: images/favicon.png
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to dark mode
+      primary: teal
+      accent: blue
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
+      primary: teal
+      accent: red
+
+  features:
+    - navigation.sections
+    - toc.integrate
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - search.share
+    - content.code.copy
+
+extra:
+  version:
+    provider: mike
+
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.details
+  - pymdownx.superfences
+  - md_in_html
+  - attr_list
+  - toc:
+      permalink: true
+      toc_depth: 2
+
+plugins:
+  - search
+  - mike
+
+nav:
+  - "index.md"
+
+copyright: Copyright © 2025 Seyed Amir Alavi.

poetry.lock

@@ -0,0 +1,21 @@
+[project]
+name = "embedids"
+version = "0.1.0"
+description = "Modern Intrusion Detection System (IDS) for Embedded Systems"
+authors = [
+    {name = "Amir Alavi",email = "[email protected]"}
+]
+license = "Apache-2.0"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "mkdocs-material (>=9.6.15,<10.0.0)",
+    "mike (>=2.1.3,<3.0.0)"
+]
+
+[tool.poetry]
+package-mode = false
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"