valmex

Valmex Docs — Portal de Documentación Técnica

Este portal consolida la documentación técnica para los sitios de Valmex:

• Casa de Bolsa: www.valmex.com.mx
• Operadora de Fondos: operadoravalmex.mx
• Multipropósito / Apps / Docs: valmex.app y subdominios (p. ej. docs.valmex.app)

La documentación está pensada para crecer en paralelo a los tres sitios, con secciones compartidas (estándares, caching, mantenimiento) y secciones específicas por sitio.

Nota: La documentación de APIs no forma parte de este repositorio por corresponder a otro proyecto.

---

Estructura

/docs
  ├─ README.md                          ← este archivo (portal)
  ├─ standards/                         ← guías y convenciones
  │   └─ guia-estilos-markdown.md
  ├─ shared/                            ← documentación reutilizable
  │   └─ caching/
  │       ├─ README.md                  ← visión general de caching compartido
  │       ├─ estrategia-cache-siteground-elementor.md
  │       └─ procedimiento-mantenimiento.md
  └─ sites/                             ← documentación por sitio
      ├─ casa-de-bolsa/
      │   └─ README.md
      ├─ operadora-de-fondos/
      │   ├─ README.md
      │   └─ caching/
      │       └─ README.md              ← puente a caching compartido
      └─ valmex-app/
          └─ README.md

---

Navegación rápida

• Estándares de documentación: standards/guia-estilos-markdown.md
• Caching (compartido): shared/caching/README.md
• Operadora de Fondos: sites/operadora-de-fondos/README.md
  • Procedimientos de Respaldo: sites/operadora-de-fondos/backups/procedimiento-respaldo-clonacion-qa.md

---

Diagrama general (Mermaid)

graph LR
    A[docs.valmex.app] --> B[Compartida /shared]
    A --> C[Sitios /sites]
    B --> B1[Caching]
    C --> C1[Casa de Bolsa]
    C --> C2[Operadora de Fondos]
    C --> C3[Valmex App]

---

Convenciones clave

• Cursivas: conceptos o definiciones.
• Negritas: comandos, archivos, variables obligatorias y pasos críticos.
• monoespaciado: rutas, parámetros, fragmentos de configuración.

Flujo de cambios

1. Crear rama para cambios en documentación.
2. Editar archivos .md en /docs.
3. Revisar visualmente (GitHub/GitLab o visor Markdown).
4. PR y revisión.