Update Documentation Structure

vicvalentim · Oct 31, 2024 · 8a3c812 · 8a3c812
1 parent 2ed4c0e
commit 8a3c812
Show file tree

Hide file tree

Showing 41 changed files with 78 additions and 72 deletions.
diff --git a/docs/en/api/core-classes.md → docs/api/core-classes.md b/docs/en/api/core-classes.md → docs/api/core-classes.md
diff --git a/docs/pt/api/core-classes.md → docs/api/core-classes.pt.md b/docs/pt/api/core-classes.md → docs/api/core-classes.pt.md
diff --git a/docs/en/api/helper-functions.md → docs/api/helper-functions.md b/docs/en/api/helper-functions.md → docs/api/helper-functions.md
diff --git a/docs/pt/api/helper-functions.md → docs/api/helper-functions.pt.md b/docs/pt/api/helper-functions.md → docs/api/helper-functions.pt.md
diff --git a/docs/en/api/overview.md → docs/api/overview.md b/docs/en/api/overview.md → docs/api/overview.md
diff --git a/docs/pt/api/overview.md → docs/api/overview.pt.md b/docs/pt/api/overview.md → docs/api/overview.pt.md
diff --git a/docs/en/api/scene-interface.md → docs/api/scene-interface.md b/docs/en/api/scene-interface.md → docs/api/scene-interface.md
diff --git a/docs/pt/api/scene-interface.md → docs/api/scene-interface.pt.md b/docs/pt/api/scene-interface.md → docs/api/scene-interface.pt.md
diff --git a/docs/en/author.md → docs/author.md b/docs/en/author.md → docs/author.md
diff --git a/docs/pt/author.md → docs/author.pt.md b/docs/pt/author.md → docs/author.pt.md
diff --git a/docs/en/contributing.md → docs/contributing.md b/docs/en/contributing.md → docs/contributing.md
diff --git a/docs/pt/contributing.md → docs/contributing.pt.md b/docs/pt/contributing.md → docs/contributing.pt.md
diff --git a/docs/en/examples/advanced.md → docs/examples/advanced.md b/docs/en/examples/advanced.md → docs/examples/advanced.md
diff --git a/docs/pt/examples/advanced.md → docs/examples/advanced.pt.md b/docs/pt/examples/advanced.md → docs/examples/advanced.pt.md
diff --git a/docs/en/examples/basic.md → docs/examples/basic.md b/docs/en/examples/basic.md → docs/examples/basic.md
diff --git a/docs/pt/examples/basic.md → docs/examples/basic.pt.md b/docs/pt/examples/basic.md → docs/examples/basic.pt.md
diff --git a/docs/en/getting-started/features.md → docs/getting-started/features.md b/docs/en/getting-started/features.md → docs/getting-started/features.md
diff --git a/docs/pt/getting-started/features.md → docs/getting-started/features.pt.md b/docs/pt/getting-started/features.md → docs/getting-started/features.pt.md
diff --git a/docs/en/getting-started/quickstart.md → docs/getting-started/quickstart.md b/docs/en/getting-started/quickstart.md → docs/getting-started/quickstart.md
diff --git a/docs/pt/getting-started/quickstart.md → docs/getting-started/quickstart.pt.md b/docs/pt/getting-started/quickstart.md → docs/getting-started/quickstart.pt.md
diff --git a/docs/en/index.md → docs/index.md b/docs/en/index.md → docs/index.md
diff --git a/docs/pt/index.md → docs/index.pt.md b/docs/pt/index.md → docs/index.pt.md
diff --git a/docs/en/installation/dependencies.md → docs/installation/dependencies.md b/docs/en/installation/dependencies.md → docs/installation/dependencies.md
diff --git a/docs/pt/installation/dependencies.md → docs/installation/dependencies.pt.md b/docs/pt/installation/dependencies.md → docs/installation/dependencies.pt.md
diff --git a/docs/en/installation/installation-steps.md → docs/installation/installation-steps.md b/docs/en/installation/installation-steps.md → docs/installation/installation-steps.md
diff --git a/docs/pt/installation/installation-steps.md → docs/installation/installation-steps.pt.md b/docs/pt/installation/installation-steps.md → docs/installation/installation-steps.pt.md
diff --git a/docs/en/installation/requirements.md → docs/installation/requirements.md b/docs/en/installation/requirements.md → docs/installation/requirements.md
diff --git a/docs/pt/installation/requirements.md → docs/installation/requirements.pt.md b/docs/pt/installation/requirements.md → docs/installation/requirements.pt.md
diff --git a/docs/en/known-issues.md → docs/known-issues.md b/docs/en/known-issues.md → docs/known-issues.md
diff --git a/docs/pt/known-issues.md → docs/known-issues.pt.md b/docs/pt/known-issues.md → docs/known-issues.pt.md
diff --git a/docs/en/license.md → docs/license.md b/docs/en/license.md → docs/license.md
diff --git a/docs/pt/license.md → docs/license.pt.md b/docs/pt/license.md → docs/license.pt.md
diff --git a/docs/en/usage/basic-usage.md → docs/usage/basic-usage.md b/docs/en/usage/basic-usage.md → docs/usage/basic-usage.md
diff --git a/docs/pt/usage/basic-usage.md → docs/usage/basic-usage.pt.md b/docs/pt/usage/basic-usage.md → docs/usage/basic-usage.pt.md
diff --git a/docs/en/usage/event-handling.md → docs/usage/event-handling.md b/docs/en/usage/event-handling.md → docs/usage/event-handling.md
diff --git a/docs/pt/usage/event-handling.md → docs/usage/event-handling.pt.md b/docs/pt/usage/event-handling.md → docs/usage/event-handling.pt.md
diff --git a/docs/en/usage/external-integration.md → docs/usage/external-integration.md b/docs/en/usage/external-integration.md → docs/usage/external-integration.md
diff --git a/docs/pt/usage/external-integration.md → docs/usage/external-integration.pt.md b/docs/pt/usage/external-integration.md → docs/usage/external-integration.pt.md
diff --git a/docs/en/usage/scene-management.md → docs/usage/scene-management.md b/docs/en/usage/scene-management.md → docs/usage/scene-management.md
diff --git a/docs/pt/usage/scene-management.md → docs/usage/scene-management.pt.md b/docs/pt/usage/scene-management.md → docs/usage/scene-management.pt.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,20 +1,31 @@
-site_name: ziviDomeLive
-site_url: "https://vicvalentim.github.io/ziviDomeLive/"
-use_directory_urls: false  # Para documentação offline
+site_name: ziviDomeLive - Processing Library Documentation
+site_url: https://vicvalentim.github.io/ziviDomeLive/
+repo_url: https://github.com/vicvalentim/ziviDomeLive
+repo_name: "GitHub"
+edit_uri: "blob/main/docs/"
+site_description: "Real-time immersive visuals and 3D rendering framework for fulldome and VR in Processing"
+site_author: "Victor Valentim"
+copyright: Copyright &copy; 2024  <a href="https://vicvalentim.com/" target="_blank">Victor Valentim</a> - MIT License
 
 theme:
   name: material
   language: en
 
   palette:
-    - scheme: slate
-      toggle:
-        icon: material/brightness-4
-        name: Switch to light mode
-    - scheme: default
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      primary: blue
+      scheme: default
       toggle:
-        icon: material/brightness-7
+        icon: material/weather-sunny 
         name: Switch to dark mode
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      primary: blue grey
+      scheme: slate
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
 
   features:
     - search.suggest
@@ -32,16 +43,45 @@ plugins:
   - search
   - offline
   - i18n:
-      docs_structure: folder
+      reconfigure_material: true
+      reconfigure_search: true
+      docs_structure: suffix
       languages:
         - locale: en
           default: true
           name: English
           build: true
         - locale: pt
-          default: false
           name: Português (Brasil)
           build: true
+          site_name: ziviDomeLive - Documentação da Biblioteca Processing
+          site_description: "Framework de visualização imersiva em tempo real e renderização 3D para fulldome e VR em Processing"
+          nav_translations:
+            Home: "Início"
+            Installation: "Instalação"
+            Requirements: "Requisitos"
+            Installation Steps: "Passos de Instalação"
+            Dependencies: "Dependências"
+            Getting Started: "Introdução"
+            Quickstart Guide: "Guia Rápido"
+            Key Features: "Funcionalidades Principais"
+            Usage: "Uso"
+            Basic Usage: "Uso Básico"
+            Scene Management: "Gerenciamento de Cenas"
+            Event Handling: "Manipulação de Eventos"
+            External Integration: "Integração Externa"
+            API Reference: "Referência da API"
+            Overview: "Visão Geral"
+            Core Classes: "Classes Principais"
+            Scene Interface: "Interface de Cena"
+            Helper Functions: "Funções Auxiliares"
+            Examples: "Exemplos"
+            Basic Examples: "Exemplos Básicos"
+            Advanced Examples: "Exemplos Avançados"
+            Contributing: "Contribuindo"
+            Known Issues: "Problemas Conhecidos"
+            Author: "Autor"
+            License: "Licença"
 
 markdown_extensions:
   - admonition
@@ -65,76 +105,42 @@ markdown_extensions:
       line_spans: __span
       pygments_lang_class: true
 
-repo_url: https://github.com/vicvalentim/ziviDomeLive
-repo_name: "GitHub"
-edit_uri: "blob/main/docs/"
-site_description: "Real-time immersive visuals and 3D rendering framework for fulldome and VR in Processing"
-site_author: "Victor Valentim"
-copyright: Copyright &copy; 2024  <a href="https://vicvalentim.com/" target="_blank">Victor Valentim</a> - MIT License
-
 extra:
   alternate:
     - name: English
-      link: /ziviDomeLive/en/
+      link: /en/
       lang: en
     - name: Português (Brasil)
-      link: /ziviDomeLive/pt/
+      link: /pt/
       lang: pt
 
 extra_css:
   - assets/extra.css
 
 # Navegação da documentação
 nav:
-  - en:
-      - Home: en/index.md
-      - Installation:
-          - Requirements: en/installation/requirements.md
-          - Installation Steps: en/installation/installation-steps.md
-          - Dependencies: en/installation/dependencies.md
-      - Getting Started:
-          - Quickstart Guide: en/getting-started/quickstart.md
-          - Key Features: en/getting-started/features.md
-      - Usage:
-          - Basic Usage: en/usage/basic-usage.md
-          - Scene Management: en/usage/scene-management.md
-          - Event Handling: en/usage/event-handling.md
-          - External Integration: en/usage/external-integration.md
-      - API Reference:
-          - Overview: en/api/overview.md
-          - Core Classes: en/api/core-classes.md
-          - Scene Interface: en/api/scene-interface.md
-          - Helper Functions: en/api/helper-functions.md
-      - Examples:
-          - Basic Examples: en/examples/basic.md
-          - Advanced Examples: en/examples/advanced.md
-      - Contributing: en/contributing.md
-      - Known Issues: en/known-issues.md
-      - Author: en/author.md
-      - License: en/license.md
-  - pt:
-      - Home: pt/index.md
-      - Instalação:
-          - Requisitos: pt/installation/requirements.md
-          - Passos de Instalação: pt/installation/installation-steps.md
-          - Dependências: pt/installation/dependencies.md
-      - Introdução:
-          - Guia Rápido: pt/getting-started/quickstart.md
-          - Funcionalidades Principais: pt/getting-started/features.md
-      - Uso:
-          - Uso Básico: pt/usage/basic-usage.md
-          - Gerenciamento de Cenas: pt/usage/scene-management.md
-          - Manipulação de Eventos: pt/usage/event-handling.md
-          - Integração Externa: pt/usage/external-integration.md
-      - Referência da API:
-          - Visão Geral: pt/api/overview.md
-          - Classes Principais: pt/api/core-classes.md
-          - Interface de Cena: pt/api/scene-interface.md
-          - Funções Auxiliares: pt/api/helper-functions.md
-      - Exemplos:
-          - Exemplos Básicos: pt/examples/basic.md
-          - Exemplos Avançados: pt/examples/advanced.md
-      - Contribuindo: pt/contributing.md
-      - Problemas Conhecidos: pt/known-issues.md
-      - Autor: pt/author.md
-      - Licença: pt/license.md
+  - Home: index.md
+  - Installation:
+      - Requirements: installation/requirements.md
+      - Installation Steps: installation/installation-steps.md
+      - Dependencies: installation/dependencies.md
+  - Getting Started:
+      - Quickstart Guide: getting-started/quickstart.md
+      - Key Features: getting-started/features.md
+  - Usage:
+      - Basic Usage: usage/basic-usage.md
+      - Scene Management: usage/scene-management.md
+      - Event Handling: usage/event-handling.md
+      - External Integration: usage/external-integration.md
+  - API Reference:
+      - Overview: api/overview.md
+      - Core Classes: api/core-classes.md
+      - Scene Interface: api/scene-interface.md
+      - Helper Functions: api/helper-functions.md
+  - Examples:
+      - Basic Examples: examples/basic.md
+      - Advanced Examples: examples/advanced.md
+  - Contributing: contributing.md
+  - Known Issues: known-issues.md
+  - Author: author.md
+  - License: license.md