Add some docs files

Mercado-Social-de-Madrid · Jun 13, 2024 · e10668e · e10668e
1 parent f78d9a9
commit e10668e
Show file tree

Hide file tree

Showing 14 changed files with 113 additions and 3 deletions.
diff --git a/documentation/admin/docs/es/perfil.md b/documentation/admin/docs/es/perfil.md
@@ -1,4 +1,4 @@
----
+`---
 icon: material/account-circle
 ---
 
@@ -19,4 +19,4 @@ Seleccionando la opción de editar perfil se abrirá una nueva pantalla donde po
 
 
 # Cerrar Sesión
-Seleccionando la opción de cerrar sesión, la aplicación finalizará la sesión con la cuenta actual y nos redigirá a la pantalla de inicio de sesión.
+Seleccionando la opción de cerrar sesión, la aplicación finalizará la sesión con la cuenta actual y nos redigirá a la pantalla de inicio de sesión.`
diff --git a/documentation/user/docs/assets/css/extra.css b/documentation/user/docs/assets/css/extra.css
@@ -0,0 +1,7 @@
+h2 {
+    color: #B6B10A;
+}
+
+.header-icon {
+    display: none; /* Hide the icon in the navigation bar */
+}
diff --git a/documentation/user/docs/assets/inicio.png b/documentation/user/docs/assets/inicio.png
diff --git a/documentation/user/docs/assets/menu_principal.png b/documentation/user/docs/assets/menu_principal.png
diff --git a/documentation/user/docs/assets/mi_entidad.png b/documentation/user/docs/assets/mi_entidad.png
diff --git a/documentation/user/docs/assets/ofertas.png b/documentation/user/docs/assets/ofertas.png
diff --git a/documentation/user/docs/assets/ventajas.png b/documentation/user/docs/assets/ventajas.png
diff --git a/documentation/user/docs/es/consumidoras/index.md b/documentation/user/docs/es/consumidoras/index.md
@@ -0,0 +1,5 @@
+---
+icon: material/walk
+---
+
+# :material-walk: Consumidoras
diff --git a/documentation/user/docs/es/proveedoras/index.md b/documentation/user/docs/es/proveedoras/index.md
@@ -0,0 +1,8 @@
+---
+icon: material/store
+---
+
+# :material-store: Proveedoras
+
+![Menú Principal](../../assets/menu_principal.png){ loading=lazy }
+
diff --git a/documentation/user/docs/es/proveedoras/inicio.md b/documentation/user/docs/es/proveedoras/inicio.md
@@ -0,0 +1,51 @@
+---
+icon: material/home-outline
+---
+
+#
+
+![Inicio](../../assets/inicio.png){ loading=lazy }
+
+La pantalla de Inicio es donde puedes encontrar toda la información clave sobre tu entidad y acceder a varias funciones importantes.
+
+## Información de la entidad
+En esta sección encontrarás información básica sobre tu entidad:
+
+  - Imagen principal
+  - Nombre de la entidad
+  - Nombre de la proveedora
+
+Además de esta información, tienes varias acciones para interactuar:
+
+- **Ver perfil**: Te lleva a la pantalla de ["Mi entidad"](mi_entidad.md).
+- **Mi carnet de socia**: Muestra tu carnet de socia.
+- **Ver balance social**: Te redirige a la sección de balance social.
+- **Ver estadísticas de favoritos**: Para consultar las estadísticas de tus elementos favoritos.
+
+
+## Ofertas
+
+Esta sección te muestra el número de ofertas activas que tienes. Desde aquí puedes:
+
+- **Ver ofertas publicadas**: Te lleva a la pantalla de [ofertas](ofertas.md).
+- **Publicar nueva oferta**: Para agregar una nueva oferta.
+
+
+## Ventajas
+
+Aquí puedes ver si tienes alguna ventaja activa. Para añadir una nueva ventaja debes ponerte en contacto con `[email protected]`. 
+En esta sección también puedes:
+
+- **Ver ventajas publicadas**: Te lleva a la pantalla de [ventajas](ventajas.md).
+- **Comprobar estado de socia**: Para verificar el estado de otra socia cuando consuma en tu entidad.
+
+## Últimas noticias
+
+Aquí puedes encontrar las noticias más recientes publicadas en tu mercado social. Cada noticia incluye:
+
+- **Imagen**: Una cartel o imagen representativa de la noticia.
+- **Nombre**: El título o nombre de la noticia.
+- **Fecha de publicación**: Para saber cuándo se publicó.
+- **Descripción corta**: Un breve resumen del contenido.
+
+Si te interesa saber más, cada noticia tiene un botón para ver la versión completa.
diff --git a/documentation/user/docs/es/proveedoras/mi_entidad.md b/documentation/user/docs/es/proveedoras/mi_entidad.md
@@ -0,0 +1,7 @@
+---
+icon: material/store-outline
+---
+
+#
+
+![Mi Entidad](../../assets/mi_entidad.png){ loading=lazy }
diff --git a/documentation/user/docs/es/proveedoras/ofertas.md b/documentation/user/docs/es/proveedoras/ofertas.md
@@ -0,0 +1,7 @@
+---
+icon: material/basket-outline
+---
+
+#
+
+![Ofertas](../../assets/ofertas.png){ loading=lazy }
diff --git a/documentation/user/docs/es/proveedoras/ventajas.md b/documentation/user/docs/es/proveedoras/ventajas.md
@@ -0,0 +1,7 @@
+---
+icon: material/ticket
+---
+
+#
+
+![Ventajas](../../assets/ventajas.png){ loading=lazy }
diff --git a/documentation/user/mkdocs.yml b/documentation/user/mkdocs.yml
@@ -2,13 +2,19 @@ yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema
 
 site_name: Guía de usuario de la AppMES
 site_url: https://0.0.0.0/docs/user
+extra_css:
+  - assets/css/extra.css
 
 theme:
   name: material
   logo: assets/brand.png
   language: es
   features:
     - navigation.instant
+    - navigation.expand
+    - navigation.indexes
+    - navigation.tracking
+    - toc.follow
   palette:
     # Palette toggle for light mode
     - media: "(prefers-color-scheme: light)"
@@ -29,11 +35,14 @@ theme:
         name: Modo claro
 
 markdown_extensions:
-  - pymdownx.emoji
+  - attr_list
   - pymdownx.blocks.admonition
   - pymdownx.blocks.details
   - pymdownx.blocks.tab:
       alternate_style: True
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
 
 plugins:
   - search
@@ -54,3 +63,12 @@ plugins:
         - locale: gl
           name: Galego
           build: true
+
+nav:
+  - Proveedoras:
+    - proveedoras/index.md
+    - proveedoras/inicio.md
+    - proveedoras/mi_entidad.md
+    - proveedoras/ofertas.md
+    - proveedoras/ventajas.md
+  - Consumidoras: consumidoras/index.md