Update Documentation

vicvalentim · Oct 30, 2024 · fd208f8 · fd208f8
1 parent 7ddbbe2
commit fd208f8
Show file tree

Hide file tree

Showing 46 changed files with 140 additions and 7 deletions.
diff --git a/.github/workflows/deploy_website.yml b/.github/workflows/deploy_website.yml
@@ -24,7 +24,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install mkdocs-dracula mkdocs-static-i18n mkdocs-material
+          pip install mkdocs-dracula-theme mkdocs-static-i18n[material] mkdocs-material
 
       - name: Build website
         run: mkdocs build

diff --git a/.github/workflows/pr_preview.yml b/.github/workflows/pr_preview.yml
@@ -28,7 +28,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install mkdocs-dracula mkdocs-static-i18n mkdocs-material
+          pip install mkdocs-dracula-theme mkdocs-static-i18n[material] mkdocs-material
 
       - name: Build website
         if: github.event.action != 'closed'

diff --git a/docs/assets/extra.css b/docs/assets/extra.css
diff --git a/docs/en/404.md b/docs/en/404.md
@@ -0,0 +1,4 @@
+# 404 - Page Not Found
+
+Oops! The page you're looking for doesn't exist.
+[Return to Home](index.md)
diff --git a/docs/en/api/core-classes.md b/docs/en/api/core-classes.md
@@ -0,0 +1,3 @@
+# Core Classes
+
+Documentation for core classes of ziviDomeLive.
diff --git a/docs/en/api/helper-functions.md b/docs/en/api/helper-functions.md
@@ -0,0 +1,3 @@
+# Helper Functions
+
+Helper functions in ziviDomeLive.
diff --git a/docs/en/api/overview.md b/docs/en/api/overview.md
@@ -0,0 +1,3 @@
+# API Overview
+
+Overview of the ziviDomeLive API.
diff --git a/docs/en/api/scene-interface.md b/docs/en/api/scene-interface.md
@@ -0,0 +1,3 @@
+# Scene Interface
+
+Explanation of the Scene interface.
diff --git a/docs/en/author.md b/docs/en/author.md
@@ -0,0 +1,3 @@
+# Author
+
+Information about the author of ziviDomeLive.
diff --git a/docs/en/contributing.md b/docs/en/contributing.md
@@ -0,0 +1,3 @@
+# Contributing
+
+Guide to contributing to ziviDomeLive.
diff --git a/docs/en/examples/advanced.md b/docs/en/examples/advanced.md
@@ -0,0 +1,3 @@
+# Advanced Examples
+
+Advanced examples for using ziviDomeLive.
diff --git a/docs/en/examples/basic.md b/docs/en/examples/basic.md
@@ -0,0 +1,3 @@
+# Basic Examples
+
+Basic examples for using ziviDomeLive.
diff --git a/docs/en/getting-started/features.md b/docs/en/getting-started/features.md
@@ -0,0 +1,3 @@
+# Key Features
+
+Overview of ziviDomeLive's main features.
diff --git a/docs/en/getting-started/quickstart.md b/docs/en/getting-started/quickstart.md
@@ -0,0 +1,3 @@
+# Quickstart Guide
+
+Get started quickly with ziviDomeLive.
diff --git a/docs/en/index.md b/docs/en/index.md
@@ -0,0 +1,3 @@
+# Welcome to ziviDomeLive Documentation
+
+This is the home page.
diff --git a/docs/en/installation/dependencies.md b/docs/en/installation/dependencies.md
@@ -0,0 +1,3 @@
+# Dependencies
+
+Dependencies needed for ziviDomeLive.
diff --git a/docs/en/installation/installation-steps.md b/docs/en/installation/installation-steps.md
@@ -0,0 +1,3 @@
+# Installation Steps
+
+Step-by-step guide to install ziviDomeLive.
diff --git a/docs/en/installation/requirements.md b/docs/en/installation/requirements.md
@@ -0,0 +1,3 @@
+# Requirements
+
+List of requirements for ziviDomeLive.
diff --git a/docs/en/known-issues.md b/docs/en/known-issues.md
@@ -0,0 +1,3 @@
+# Known Issues
+
+List of known issues in ziviDomeLive.
diff --git a/docs/en/license.md b/docs/en/license.md
@@ -0,0 +1,3 @@
+# License
+
+GPL-2.0 license information for ziviDomeLive.
diff --git a/docs/en/usage/basic-usage.md b/docs/en/usage/basic-usage.md
@@ -0,0 +1,3 @@
+# Basic Usage
+
+Basic usage instructions for ziviDomeLive.
diff --git a/docs/en/usage/event-handling.md b/docs/en/usage/event-handling.md
@@ -0,0 +1,3 @@
+# Event Handling
+
+Handling events in ziviDomeLive.
diff --git a/docs/en/usage/external-integration.md b/docs/en/usage/external-integration.md
@@ -0,0 +1,3 @@
+# External Integration
+
+Integrate ziviDomeLive with external tools.
diff --git a/docs/en/usage/scene-management.md b/docs/en/usage/scene-management.md
@@ -0,0 +1,3 @@
+# Scene Management
+
+How to manage scenes in ziviDomeLive.
diff --git a/docs/pt-br/404.md b/docs/pt-br/404.md
@@ -0,0 +1,4 @@
+# 404 - Página Não Encontrada
+
+Ops! A página que você está procurando não existe.
+[Voltar ao Início](index.md)
diff --git a/docs/pt-br/api/core-classes.md b/docs/pt-br/api/core-classes.md
@@ -0,0 +1,3 @@
+# Classes Principais
+
+Documentação das classes principais da ziviDomeLive.
diff --git a/docs/pt-br/api/helper-functions.md b/docs/pt-br/api/helper-functions.md
@@ -0,0 +1,3 @@
+# Funções Auxiliares
+
+Funções auxiliares da ziviDomeLive.
diff --git a/docs/pt-br/api/overview.md b/docs/pt-br/api/overview.md
@@ -0,0 +1,3 @@
+# Visão Geral da API
+
+Visão geral da API da ziviDomeLive.
diff --git a/docs/pt-br/api/scene-interface.md b/docs/pt-br/api/scene-interface.md
@@ -0,0 +1,3 @@
+# Interface de Cena
+
+Explicação sobre a interface de cenas.
diff --git a/docs/pt-br/author.md b/docs/pt-br/author.md
@@ -0,0 +1,3 @@
+# Autor
+
+Informações sobre o autor da ziviDomeLive.
diff --git a/docs/pt-br/contributing.md b/docs/pt-br/contributing.md
@@ -0,0 +1,3 @@
+# Contribuindo
+
+Guia para contribuir com a ziviDomeLive.
diff --git a/docs/pt-br/examples/advanced.md b/docs/pt-br/examples/advanced.md
@@ -0,0 +1,3 @@
+# Exemplos Avançados
+
+Exemplos avançados de uso da ziviDomeLive.
diff --git a/docs/pt-br/examples/basic.md b/docs/pt-br/examples/basic.md
@@ -0,0 +1,3 @@
+# Exemplos Básicos
+
+Exemplos básicos de uso da ziviDomeLive.
diff --git a/docs/pt-br/getting-started/features.md b/docs/pt-br/getting-started/features.md
@@ -0,0 +1,3 @@
+# Funcionalidades Principais
+
+Visão geral das principais funcionalidades da ziviDomeLive.
diff --git a/docs/pt-br/getting-started/quickstart.md b/docs/pt-br/getting-started/quickstart.md
@@ -0,0 +1,3 @@
+# Guia Rápido
+
+Comece rapidamente com a ziviDomeLive.
diff --git a/docs/pt-br/index.md b/docs/pt-br/index.md
@@ -0,0 +1,3 @@
+# Bem-vindo à Documentação da ziviDomeLive
+
+Esta é a página inicial.
diff --git a/docs/pt-br/installation/dependencies.md b/docs/pt-br/installation/dependencies.md
@@ -0,0 +1,3 @@
+# Dependências
+
+Dependências necessárias para a ziviDomeLive.
diff --git a/docs/pt-br/installation/installation-steps.md b/docs/pt-br/installation/installation-steps.md
@@ -0,0 +1,3 @@
+# Passo a Passo de Instalação
+
+Guia de instalação passo a passo para a ziviDomeLive.
diff --git a/docs/pt-br/installation/requirements.md b/docs/pt-br/installation/requirements.md
@@ -0,0 +1,3 @@
+# Requisitos
+
+Lista de requisitos para a ziviDomeLive.
diff --git a/docs/pt-br/known-issues.md b/docs/pt-br/known-issues.md
@@ -0,0 +1,3 @@
+# Problemas Conhecidos
+
+Lista de problemas conhecidos na ziviDomeLive.
diff --git a/docs/pt-br/license.md b/docs/pt-br/license.md
@@ -0,0 +1,3 @@
+# Licença
+
+Informações da licença GPL-2.0 para a ziviDomeLive.
diff --git a/docs/pt-br/usage/basic-usage.md b/docs/pt-br/usage/basic-usage.md
@@ -0,0 +1,3 @@
+# Uso Básico
+
+Instruções básicas de uso para a ziviDomeLive.
diff --git a/docs/pt-br/usage/event-handling.md b/docs/pt-br/usage/event-handling.md
@@ -0,0 +1,3 @@
+# Manipulação de Eventos
+
+Como lidar com eventos na ziviDomeLive.
diff --git a/docs/pt-br/usage/external-integration.md b/docs/pt-br/usage/external-integration.md
@@ -0,0 +1,3 @@
+# Integração Externa
+
+Integre a ziviDomeLive com ferramentas externas.
diff --git a/docs/pt-br/usage/scene-management.md b/docs/pt-br/usage/scene-management.md
@@ -0,0 +1,3 @@
+# Gerenciamento de Cenas
+
+Como gerenciar cenas na ziviDomeLive.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -20,11 +20,16 @@ copyright: MIT Licence.
 plugins:
   - search
   - offline
-  - i18n:
-      default_language: en
-      languages:
-        en: English
-        pt-br: Português (Brasil)
+  - - i18n:
+        docs_structure: suffix
+        languages:
+          - locale: en
+            default: true
+            name: English
+            build: true
+          - locale: pt-br
+            name: Português (Brasil)
+            build: true
 
 extra_css:
   - assets/extra.css