Initial sections commit

.gitea/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - dev
+      - main
+    tags-ignore:
+      - v*
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    container: catthehacker/ubuntu:act-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+        env:
+          AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
+      - name: Install dependencies
+        run: |
+          python -m pip install -r requirements.txt
+      - name: Test the build
+        run: TZ=UTC mkdocs build

.renovaterc

@@ -0,0 +1,20 @@
+{
+    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+    "extends": [
+        "config:base"
+    ],
+    "baseBranches": [
+        "dev"
+    ],
+    "packageRules": [
+        {
+            "matchUpdateTypes": [
+                "minor",
+                "patch",
+                "pin",
+                "digest"
+            ],
+            "automerge": true
+        }
+    ]
+}

README.md

@@ -1,2 +1,3 @@
-# Docs
+# Garbage Reminder Documentation
 
+This documentation is under development and is not finished yet.

docs/api/index.md

@@ -0,0 +1 @@
+# API

docs/bot_telegram/index.md

@@ -0,0 +1 @@
+# Telegram Bot

docs/community/index.md

@@ -0,0 +1 @@
+# Community

docs/community/public/index.md

@@ -0,0 +1 @@
+# Public instance

docs/index.md

@@ -0,0 +1,3 @@
+# Welcome to Garbage Reminder
+
+This documentation is under development and is not finished yet.

docs/stylesheets/extra.css

@@ -0,0 +1,5 @@
+:root {
+    --md-primary-fg-color: #A9C217;
+    --md-primary-fg-color--light: #A9C217;
+    --md-primary-fg-color--dark: #A9C217;
+}

mkdocs.yml

@@ -0,0 +1,94 @@
+site_name: Garbage Reminder
+repo_url: https://git.end-play.xyz/GarbageReminder
+repo_name: GarbageReminder
+nav:
+  - Home: index.md
+  - API:
+    - api/index.md
+    - Installation: api/installation.md
+    - Configuration: api/configuration.md
+    - Upgrading: api/upgrading.md
+  - Telegram Bot:
+    - bot_telegram/index.md
+    - Installation: bot_telegram/installation.md
+    - Configuration: bot_telegram/configuration.md
+    - Upgrading: bot_telegram/upgrading.md
+  - Community:
+    - community/index.md
+    - Contributing: community/contributing.md
+    - Reporting a bug: community/report-bug.md
+    - Adding translations: community/translate.md
+    - Get in touch: community/contact.md
+    - Public instance:
+      - community/public/index.md
+      - Adding entries: community/public/entries.md
+      - Adding locations: community/public/locations.md
+      - Report a problem: community/public/report.md
+extra:
+  social:
+    - icon: fontawesome/brands/git-alt
+      link: https://git.end-play.xyz/GarbageReminder
+    - icon: fontawesome/solid/globe
+      link: https://api.garbagebot.eu/docs
+    - icon: fontawesome/brands/telegram
+      link: https://garbagebot.eu/telegram
+    - icon: fontawesome/brands/discord
+      link: https://garbagebot.eu/discord
+extra_css:
+  - stylesheets/extra.css
+theme:
+  name: material
+  logo: assets/logo.png
+  favicon: assets/favicon.png
+  features:
+    - announce.dismiss
+    - content.action.edit
+    - content.action.view
+    - content.code.annotate
+    - content.code.copy
+    # - content.code.select
+    # - content.footnote.tooltips
+    # - content.tabs.link
+    - content.tooltips
+    # - header.autohide
+    # - navigation.expand
+    - navigation.footer
+    - navigation.indexes
+    # - navigation.instant
+    # - navigation.instant.prefetch
+    # - navigation.instant.progress
+    # - navigation.prune
+    - navigation.sections
+    - navigation.tabs
+    # - navigation.tabs.sticky
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+    # - toc.integrate
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/link
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: custom
+      accent: custom
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: custom
+      accent: custom
+      toggle:
+        icon: material/toggle-switch-off
+        name: Switch to system preference
+  font:
+    text: Roboto
+    code: Roboto Mono
+  icon:
+    logo: logo

requirements.txt

@@ -0,0 +1 @@
+mkdocs-material~=9.5.21