Update Documentation

vicvalentim · Oct 30, 2024 · 9678a77 · 9678a77
1 parent 60b9fc3
commit 9678a77
Show file tree

Hide file tree

Showing 50 changed files with 202 additions and 295 deletions.
diff --git a/.github/workflows/deploy_website.yml b/.github/workflows/deploy_website.yml
@@ -20,7 +20,7 @@ jobs:
           python-version: 3.x
 
       - name: Install dependencies
-        run: pip install mkdocs-material
+        run: pip install mkdocs-material mkdocs-static-i18n
 
       - name: Build website
         run: mkdocs build

diff --git a/.github/workflows/pr_preview.yml b/.github/workflows/pr_preview.yml
@@ -24,7 +24,7 @@ jobs:
           python-version: 3.x
 
       - name: Install dependencies
-        run: pip install mkdocs-material
+        run: pip install mkdocs-material mkdocs-static-i18n
 
       - name: Build website
         if: github.event.action != 'closed'

diff --git a/docs/assets/extra.css b/docs/assets/extra.css
diff --git a/docs/develop.md b/docs/develop.md
diff --git a/docs/en/api/core-classes.md b/docs/en/api/core-classes.md
@@ -0,0 +1,2 @@
+# Core Classes
+Description of the core classes.
diff --git a/docs/en/api/helper-functions.md b/docs/en/api/helper-functions.md
@@ -0,0 +1,2 @@
+# Helper Functions
+List of helper functions.
diff --git a/docs/en/api/overview.md b/docs/en/api/overview.md
@@ -0,0 +1,2 @@
+# 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,2 @@
+# Scene Interface
+Interface for scene management.
diff --git a/docs/en/author.md b/docs/en/author.md
@@ -0,0 +1,2 @@
+# Author
+Information about the author.
diff --git a/docs/en/contributing.md b/docs/en/contributing.md
@@ -0,0 +1,2 @@
+# Contributing
+How to contribute to the ziviDomeLive library.
diff --git a/docs/en/examples/advanced.md b/docs/en/examples/advanced.md
@@ -0,0 +1,2 @@
+# Advanced Examples
+Advanced usage examples.
diff --git a/docs/en/examples/basic.md b/docs/en/examples/basic.md
@@ -0,0 +1,2 @@
+# Basic Examples
+Basic examples of usage.
diff --git a/docs/en/getting-started/features.md b/docs/en/getting-started/features.md
@@ -0,0 +1,2 @@
+# Key Features
+Main features of the ziviDomeLive library.
diff --git a/docs/en/getting-started/quickstart.md b/docs/en/getting-started/quickstart.md
@@ -0,0 +1,2 @@
+# Quickstart Guide
+Begin with using ziviDomeLive quickly.
diff --git a/docs/en/index.md b/docs/en/index.md
@@ -0,0 +1,2 @@
+# Welcome to ziviDomeLive Documentation
+This is the main page for the English documentation.
diff --git a/docs/en/installation/dependencies.md b/docs/en/installation/dependencies.md
@@ -0,0 +1,2 @@
+# Dependencies
+Details on library dependencies.
diff --git a/docs/en/installation/installation-steps.md b/docs/en/installation/installation-steps.md
@@ -0,0 +1,2 @@
+# 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,2 @@
+# Requirements
+List of requirements for installing ziviDomeLive.
diff --git a/docs/en/known-issues.md b/docs/en/known-issues.md
@@ -0,0 +1,2 @@
+# Known Issues
+List of known issues in the library.
diff --git a/docs/en/license.md b/docs/en/license.md
@@ -0,0 +1,2 @@
+# License
+Details about the license.
diff --git a/docs/en/usage/basic-usage.md b/docs/en/usage/basic-usage.md
@@ -0,0 +1,2 @@
+# Basic Usage
+Guide to basic usage of ziviDomeLive.
diff --git a/docs/en/usage/event-handling.md b/docs/en/usage/event-handling.md
@@ -0,0 +1,2 @@
+# Event Handling
+Manage events within ziviDomeLive.
diff --git a/docs/en/usage/external-integration.md b/docs/en/usage/external-integration.md
@@ -0,0 +1,2 @@
+# External Integration
+Integrating with other tools and libraries.
diff --git a/docs/en/usage/scene-management.md b/docs/en/usage/scene-management.md
@@ -0,0 +1,2 @@
+# Scene Management
+Handling and managing scenes.
diff --git a/docs/example_sketch_output.jpg b/docs/example_sketch_output.jpg
diff --git a/docs/getting-started.md b/docs/getting-started.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/pt/api/core-classes.md b/docs/pt/api/core-classes.md
@@ -0,0 +1,2 @@
+# Classes Principais
+Descrição das classes principais.
diff --git a/docs/pt/api/helper-functions.md b/docs/pt/api/helper-functions.md
@@ -0,0 +1,2 @@
+# Funções Auxiliares
+Lista de funções auxiliares.
diff --git a/docs/pt/api/overview.md b/docs/pt/api/overview.md
@@ -0,0 +1,2 @@
+# Visão Geral da API
+Visão geral da API do ziviDomeLive.
diff --git a/docs/pt/api/scene-interface.md b/docs/pt/api/scene-interface.md
@@ -0,0 +1,2 @@
+# Interface de Cena
+Interface para gerenciamento de cenas.
diff --git a/docs/pt/author.md b/docs/pt/author.md
@@ -0,0 +1,2 @@
+# Autor
+Informações sobre o autor.
diff --git a/docs/pt/contributing.md b/docs/pt/contributing.md
@@ -0,0 +1,2 @@
+# Contribuindo
+Como contribuir para a biblioteca ziviDomeLive.
diff --git a/docs/pt/examples/advanced.md b/docs/pt/examples/advanced.md
@@ -0,0 +1,2 @@
+# Exemplos Avançados
+Exemplos avançados de uso.
diff --git a/docs/pt/examples/basic.md b/docs/pt/examples/basic.md
@@ -0,0 +1,2 @@
+# Exemplos Básicos
+Exemplos básicos de uso.
diff --git a/docs/pt/getting-started/features.md b/docs/pt/getting-started/features.md
@@ -0,0 +1,2 @@
+# Funcionalidades Principais
+Principais funcionalidades da biblioteca ziviDomeLive.
diff --git a/docs/pt/getting-started/quickstart.md b/docs/pt/getting-started/quickstart.md
@@ -0,0 +1,2 @@
+# Guia Rápido
+Comece a usar o ziviDomeLive rapidamente.
diff --git a/docs/pt/index.md b/docs/pt/index.md
@@ -0,0 +1,2 @@
+# Bem-vindo à Documentação ziviDomeLive
+Esta é a página principal para a documentação em português.
diff --git a/docs/pt/installation/dependencies.md b/docs/pt/installation/dependencies.md
@@ -0,0 +1,2 @@
+# Dependências
+Detalhes sobre as dependências da biblioteca.
diff --git a/docs/pt/installation/installation-steps.md b/docs/pt/installation/installation-steps.md
@@ -0,0 +1,2 @@
+# Passos de Instalação
+Guia passo a passo para instalar o ziviDomeLive.
diff --git a/docs/pt/installation/requirements.md b/docs/pt/installation/requirements.md
@@ -0,0 +1,2 @@
+# Requisitos
+Lista de requisitos para instalar o ziviDomeLive.
diff --git a/docs/pt/known-issues.md b/docs/pt/known-issues.md
@@ -0,0 +1,2 @@
+# Problemas Conhecidos
+Lista de problemas conhecidos na biblioteca.
diff --git a/docs/pt/license.md b/docs/pt/license.md
@@ -0,0 +1,2 @@
+# Licença
+Detalhes sobre a licença.
diff --git a/docs/pt/usage/basic-usage.md b/docs/pt/usage/basic-usage.md
@@ -0,0 +1,2 @@
+# Uso Básico
+Guia para o uso básico do ziviDomeLive.
diff --git a/docs/pt/usage/event-handling.md b/docs/pt/usage/event-handling.md
@@ -0,0 +1,2 @@
+# Manipulação de Eventos
+Gerencie eventos dentro do ziviDomeLive.
diff --git a/docs/pt/usage/external-integration.md b/docs/pt/usage/external-integration.md
@@ -0,0 +1,2 @@
+# Integração Externa
+Integração com outras ferramentas e bibliotecas.
diff --git a/docs/pt/usage/scene-management.md b/docs/pt/usage/scene-management.md
@@ -0,0 +1,2 @@
+# Gerenciamento de Cenas
+Manipulação e gerenciamento de cenas.