alimitedgroup.github.io/mkdocs.yml at main · alimitedgroup/alimitedgroup.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
site_name: Manuale Utente
copyright: Copyright &copy; 2024 - 2025 ALimitedGroup
docs_dir: 03-PB/manuale-utente
site_dir: dist/docs

nav:
  - Introduzione: index.md
  - Concetti:
      - Tipi di utenti: concetti/tipi-utenti.md
      - Autenticazione: concetti/autenticazione.md
      - Merce: concetti/merci.md
      - Ordine: concetti/ordini.md
      - Riassortimento: concetti/riassortimenti.md
      - Trasferimento: concetti/trasferimenti.md
  - Test:
      - Backup: operazione/Test.md
  - Installazione:
      - Requisiti:
          - Requisiti Hardware: installazione/requisiti/requisiti-hw.md
          - Requisiti Software: installazione/requisiti/requisiti-sw.md
      - Preparazione del Sistema:
          - Installazione del Software: installazione/preparazione-del-sistema/01-installazione-sw.md
          - Personalizzare la configurazione: installazione/preparazione-del-sistema/02-configurare-ms.md
          - Avviare il Sistema: installazione/preparazione-del-sistema/03-avvio-sistema.md
    # Forse: aggiungere "Installazione con Kubernetes" 👀
  - Guide:
      - Effettuare il login: guide/login.md
      - Aggiungere una merce: guide/aggiunta-merce.md
      - Aggiungere stock di una merce: guide/aggiunta-stock.md
      - Rimuovere stock di una merce: guide/rimozione-stock.md
      - Visualizzare le merci nel Sistema: guide/visualizza-merce.md
      - Visualizzare i magazzini presenti nel Sistema: guide/visualizza-magazzini.md
      - Effettuare un ordine: guide/ordine.md
      - Visualizzare gli ordini eseguiti: guide/visualizza-ordini.md
      - Effettuare un trasferimento: guide/trasferimento.md
      - Visualizzare i trasferimenti eseguiti: guide/visualizza-trasferimenti.md
      - Impostare una soglia di allerta: guide/soglia.md
      - Visualizzare le soglie impostate: guide/visualizza-soglie.md
      - Ricevere le notifiche: guide/notifiche.md
  - Telemetria:
      - Configurazione di Grafana: telemetria/config.md
      - Importare e modificare una dashboard: telemetria/dashboard.md
  - Riferimento API:
      - GET /api/v1/ping: reference/ping.md
      - POST /api/v1/login: reference/login.md
      - GET /api/v1/is_logged: reference/is_logged.md
      - GET /api/v1/goods: reference/get_goods.md
      - GET /api/v1/warehouses: reference/get_warehouses.md
      - GET /api/v1/orders: reference/get_orders.md
      - GET /api/v1/transfers: reference/get_transfers.md
      - POST /api/v1/goods: reference/create_good.md
      - POST /api/v1/orders: reference/create_order.md
      - POST /api/v1/transfers: reference/create_transfer.md
      - PUT /api/v1/goods/:good_id: reference/update_good.md
      - POST /api/v1/goods/:good_id/warehouse/:warehouse_id/stock: reference/add_stock.md
      - DELETE /api/v1/goods/:good_id/warehouse/:warehouse_id/stock: reference/remove_stock.md
      - POST /api/v1/notifications/queries: reference/create_notification_query.md
      - GET /api/v1/notifications/queries: reference/get_notification_queries.md

hooks:
  - 03-PB/manuale-utente/preprocess.py

theme:
  name: material
  language: it

  features:
    - navigation.instant
    - navigation.tabs
    - toc.follow

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ALimitedGroup
    - icon: material/web
      link: https://alimitedgroup.github.io