feat: initial commit

.gitattributes

@@ -0,0 +1,4 @@
+docs/javascripts/* linguist-vendored
+eslint.config.mjs linguist-generated
+package-lock.json linguist-generated
+package.json linguist-generated

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug Report
+about: Report an issue or bug in the documentation
+title: "[BUG] "
+labels: bug
+assignees: ""
+---
+
+## Bug Report
+
+**Document Title:**
+
+**Current URL/Location:**
+
+**Description of Issue:** (What is the issue? Typo, broken link,
+incorrect information, etc.)
+
+**Expected Behavior:** (What should the correct information be?)
+
+---
+
+### Additional Information
+
+Include any other relevant information, screenshots,
+or logs that might help in resolving the issue.
+
+---
+
+### Checklist
+
+- [ ] I have searched the existing issues for related topics.
+- [ ] I have provided all necessary information to reproduce the issue.

.github/ISSUE_TEMPLATE/epic.md

@@ -0,0 +1,46 @@
+---
+name: Epic
+about: A parent issue that tracks multiple sub-issues
+title: "[EPIC] "
+labels: epic
+assignees: ""
+---
+
+## Epic Overview
+
+**Description:**
+Provide a clear and concise description of the overall goal of this epic.
+Include any relevant background information.
+
+---
+
+### Sub-Issues
+
+List the sub-issues that are part of this epic.
+These should be created as separate issues and linked here.
+
+- [ ] #SubIssue1
+- [ ] #SubIssue2
+- [ ] #SubIssue3
+
+---
+
+### Success Criteria
+
+Describe what success looks like for this epic.
+Include any measurable outcomes or key results.
+
+---
+
+### Additional Information
+
+Include any other relevant information, screenshots,
+or notes that might help in tracking and completing this epic.
+
+---
+
+### Checklist
+
+- [ ] All sub-issues are created and linked
+- [ ] Description and success criteria are clear
+- [ ] Epic is assigned to the appropriate milestone

.github/ISSUE_TEMPLATE/new_document.md

@@ -0,0 +1,35 @@
+---
+name: New Document
+about: Suggest a new document to be added to the documentation
+title: "[NEW DOC] "
+labels: documentation
+assignees: ""
+---
+
+## New Document Request
+
+**Title:**
+
+**Purpose:** (Why is this document needed? What problem does it solve?)
+
+**Target Audience:** (Who is the intended reader? Beginners,
+advanced users, developers, etc.)
+
+**Key Sections:** (List out the main sections or headings that should be included)
+
+**References:** (Any external resources, links,
+or documents that should be referenced or included)
+
+---
+
+### Additional Information
+
+Include any other relevant information, screenshots,
+or notes that might help in creating this new document.
+
+---
+
+### Checklist
+
+- [ ] I have searched the existing issues for related topics.
+- [ ] I have outlined the main sections and purpose.

.github/ISSUE_TEMPLATE/question_clarification.md

@@ -0,0 +1,29 @@
+---
+name: Question/Clarification
+about: Ask a question or request a clarification about the documentation
+title: "[QUESTION] "
+labels: question
+assignees: ""
+---
+
+## Question/Clarification
+
+**Document Title:**
+
+**Current URL/Location:**
+
+**Specific Question:** (What is your question or what needs to be clarified?)
+
+---
+
+### Additional Information
+
+Include any other relevant information that might help in addressing your
+question or clarification.
+
+---
+
+### Checklist
+
+- [ ] I have searched the existing issues for related topics.
+- [ ] I have provided all necessary information to understand the request.

.github/ISSUE_TEMPLATE/update_document.md

@@ -0,0 +1,32 @@
+---
+name: Update Document
+about: Suggest an update to an existing document
+title: "[UPDATE DOC] "
+labels: documentation
+assignees: ""
+---
+
+## Update Document Request
+
+**Document Title:**
+
+**Current URL/Location:**
+
+**Changes Required:** (Describe what needs to be added, updated, or removed)
+
+**Reason for Update:** (Why is this update needed? Is it outdated, incorrect,
+or missing information?)
+
+---
+
+### Additional Information
+
+Include any other relevant information, screenshots,
+or notes that might help in updating this document.
+
+---
+
+### Checklist
+
+- [ ] I have searched the existing issues for related topics.
+- [ ] The changes reflect the current state of the project.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,61 @@
+# Documentation Pull Request Template
+
+## Description
+
+Provide a brief description of the changes in this pull request.
+Explain the purpose and scope of the document, the problem it solves,
+or the improvement it provides.
+
+---
+
+## Type of Change
+
+- [ ] New Document
+- [ ] Update to Existing Document
+- [ ] Bug Fix
+- [ ] Question/clarification
+- [ ] Other (please describe):
+
+---
+
+## Related Issues
+
+Link any related issues or pull requests here.
+Use the format `Fixes #issue-number` to automatically close the related issue
+when this pull request is merged.
+
+---
+
+## Checklist
+
+- [ ] I have reviewed the existing documentation to avoid duplication.
+- [ ] The new or updated document includes clear and concise information.
+- [ ] All relevant sections (e.g., introduction, usage examples, references)
+      are included.
+- [ ] The document follows the project's style guide and formatting rules.
+- [ ] I have included any necessary references or external resources.
+- [ ] Spellcheck and grammar check have been performed.
+- [ ] (For updates) I have verified that the changes reflect the current state
+      of the project.
+
+---
+
+## Additional Information
+
+Include any other relevant information, screenshots,
+or notes that might help in reviewing this pull request.
+
+---
+
+## Reviewer Checklist
+
+- [ ] The purpose and scope of the document are clear.
+- [ ] The document is easy to understand and follow.
+- [ ] There are no typos or grammatical errors.
+- [ ] All necessary sections are included and well-structured.
+- [ ] The document is consistent with the project's style guide.
+- [ ] Any referenced links or resources are valid and appropriate.
+
+---
+
+**Thank you for contributing to our documentation!**

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/check.yml

@@ -0,0 +1,46 @@
+name: Lint
+
+on: [pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: "9"
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Check formatting
+        run: pnpm format:check
+
+      - name: Run ESLint
+        run: pnpm lint:check
+
+      - name: Run Spellcheck
+        run: pnpm spell:check

.github/workflows/mkdocs.yml

@@ -0,0 +1,61 @@
+name: mkdocs
+
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - name: Install dependencies
+        run: pip install mkdocs-material
+
+      - name: Build documentation
+        run: mkdocs build --strict
+
+      - name: Upload site as artifact
+        if: ${{ github.event_name == 'pull_request' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: mkdocs-site-preview
+          path: site # Upload the `site` directory generated by MkDocs
+
+  deploy:
+    name: Deploy GitHub Pages
+    if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - name: Install dependencies
+        run: pip install mkdocs-material
+
+      - name: Deploy GitHub Pages
+        run: mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1,15 @@
+# mkdocs-material build
+site/
+.cache
+__pycache__
+
+# IDE files
+.vscode/
+.idea/
+
+# JavaScript build artifacts
+node_modules/
+.pnpm-store/
+
+# macOS files
+.DS_Store

.prettierignore

@@ -0,0 +1 @@
+pnpm-lock.yaml

.prettierrc.yaml

@@ -0,0 +1,10 @@
+# number of characters per line
+printWidth: 80
+# convert tabs to spaces
+useTabs: false
+# number of spaces per tab
+tabWidth: 2
+# do not wrap prose in markdown based on `printWidth`
+proseWrap: preserve
+# use double quotes
+singleQuote: false