Mejorar este manual¶
El manual está escrito en Markdown bajo docs/ y se construye con MkDocs.
Vista previa local¶
Cree un entorno e instale dependencias:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Abra la dirección mostrada. La vista se reconstruye al cambiar un archivo.
Validar el sitio¶
Antes de una pull request:
El modo estricto informa de navegación ausente, enlaces inválidos detectados y avisos de configuración.
Principios de redacción¶
- Escribir para una tarea y público concretos.
- Indicar la versión si el comportamiento depende de ella.
- Preferir ejemplos probados a listas exhaustivas.
- No incluir credenciales reales ni datos privados.
- Enlazar tareas relacionadas en vez de duplicar secciones grandes.
- Actualizar conjuntamente todas las traducciones.
Traducciones¶
El inglés es la referencia. Alemán, francés y español usan la misma ruta con sufijo:
Si falta una traducción, el sitio vuelve al inglés. Una traducción conserva código, nombres de ajustes, avisos y enlaces, usando términos naturales.
Alcance¶
Esta documentación corresponde a MRBS 1.12.2. Los cambios de versiones posteriores deben actualizar el alcance visible o desarrollarse en su documentación correspondiente.