Saltar a contenido

🌐 GitHub Pages

Qué publica este repositorio

GitHub Pages presenta la documentación: objetivo, guías, diagramas, casos y roadmap. Es una referencia pública para leer antes o después de usar el laboratorio.

La página Economía virtual documenta el vertical de videojuegos y muestra diagramas, fuentes y runbooks. Pages no ejecuta sus nueve escenarios: para eso debes levantar localhost y usar la sección “Compra 1.000 GEM por CLP 5.990”. El PDF publicado incluye el mismo vertical como capítulo navegable, sin convertirlo en una familia de pago adicional.

La dirección esperada es:

https://vladimiracunadev-create.github.io/universal-payments-engineering-lab/

Qué no puede hacer

Pages sirve archivos estáticos. Por eso:

  • no ejecuta Python;
  • no responde POST /api/demo/{familia};
  • no consulta bancos ni PSP;
  • no recibe webhooks de forma segura;
  • no guarda secretos ni variables de backend.

Para ejecutar el recorrido debes clonar el repositorio y usar localhost. Para SANDBOX necesitas además un backend autorizado y, si el proveedor envía webhooks, una URL HTTPS controlada.

flowchart LR P[GitHub Pages\ndocumentación pública] -->|enseña y enlaza| D[Desarrollador] D -->|clona y ejecuta| L[Localhost\nPython + DEMO] L -.-> S[Sandbox autorizado] S -.-> B[Backend de desarrollo\ncon webhook HTTPS]

Fuente y despliegue: Markdown entra, HTML sale

La única fuente editorial es docs/**/*.md. No se mantienen copias .html junto a cada guía. mkdocs.yml define navegación y tema; el workflow .github/workflows/pages.yml ejecuta mkdocs build --strict y genera el HTML en un artefacto temporal llamado site.

flowchart LR C["Catálogo y playbooks"] --> M["28 guías Markdown<br/>fuente revisable"] M --> K["MkDocs strict"] K --> H["HTML generado"] C --> D["PDF navegable<br/>28 diagramas"] H --> A["Artefacto Pages"] D --> A A --> P["GitHub Pages"]

Por eso la URL pública termina en .html, pero el árbol docs/ del repositorio contiene Markdown. Cada push a main que toca documentación ejecuta Documentation Pages; la publicación sólo continúa si la construcción estricta y la comprobación de enlaces terminan correctamente.

El mismo workflow regenera el PDF navegable, comprueba sus 28 casos, 28 diagramas vectoriales y enlaces internos, y lo añade al artefacto sin convertirlo en otra fuente editorial. La guía de formatos muestra la correspondencia.

Seguridad

Nunca incluyas en Markdown, JavaScript, configuración de MkDocs o capturas:

  • access tokens;
  • API keys;
  • códigos privados de comercio;
  • secretos de webhook;
  • tarjetas, cuentas o datos personales reales.

Los ejemplos usan marcadores y nombres de variables. Los valores se inyectan únicamente en el proceso backend descrito en configuración local.