Mantener la documentación en inglés y español¶

El sitio público de documentación se genera con MkDocs y admite dos configuraciones regionales: inglés (predeterminado) y español (México). El selector de idioma aparece en el encabezado de la documentación al compilar el sitio.

Nombres de archivo¶

Inglés (idioma predeterminado): use el nombre de archivo habitual, por ejemplo workflow/bids.md.
Español: agregue el sufijo de configuración regional .es antes de .md, por ejemplo workflow/bids.es.md, en la misma carpeta que la página en inglés.

Toda página en inglés que se publique a usuarios debe tener un *.es.md correspondiente. Si falta el archivo en español, la compilación puede recurrir al inglés; no dependa de eso para contenido nuevo o actualizado—actualice ambos archivos a la vez.

Español mexicano y etiquetas de la interfaz¶

Redacte el texto explicativo en español de México (vocabulario y convenciones ortográficas apropiadas para México, no para España).
Mantenga las cadenas de la interfaz exactamente como aparecen en el producto, en inglés: nombres de pantalla (Dashboard, Bids, Jobs), botones (Create new, Submit, Post Update), estados (Bid Approved, In Progress) y nombres de rol cuando coincidan con la aplicación (Owner, Project Manager, Badge Worker). Los lectores deben reconocer las mismas etiquetas que ven en Hardhat Flow.

Use español alrededor de esos términos para gramática y claridad, por ejemplo: “En la lista de Jobs, seleccione …”.

Enlaces entre páginas¶

Use enlaces relativos sin sufijo de configuración regional, por ejemplo [Registro de pagos](payments.md). MkDocs resuelve el archivo de idioma correcto para la compilación actual.

Títulos de navegación¶

Los títulos de sección y página en la barra lateral en español se configuran en plugins.i18n.languages → nav_translations para la configuración regional es en docs-site/mkdocs.yml. Cuando agregue una entrada nueva de navegación en inglés, agregue ahí la etiqueta en español correspondiente.

Compilación¶

Desde la raíz del repositorio:

uv run mkdocs build -f docs-site/mkdocs.yml

La salida en inglés va a docs_build/; la española va a docs_build/es/.