Cómo contribuir
Cómo proponer correcciones, recetas y términos del glosario, qué estilo seguir, cómo usar las plantillas y el flujo de trabajo con Obsidian y git.
PáginasMoreContext es abierto y mejora con cada corrección. Puedes ayudar de tres formas: avisar de un error, proponer un cambio pequeño o aportar contenido nuevo, como una receta o un término del glosario. Todo pasa por el repositorio público en GitHub.
Proponer una corrección
Abre una incidencia (issue) en el repositorio cuando veas:
- Un dato técnico incorrecto o desactualizado.
- Un ejemplo de código que no funciona.
- Un enlace roto o una explicación confusa.
Para que se pueda arreglar rápido, incluye la URL de la página, qué esperabas y qué has encontrado. Si es código, añade la versión del SDK y el mensaje de error completo. Si sabes la solución, puedes abrir directamente un pull request.
Proponer recetas y términos
Las recetas y los términos del glosario son la forma más sencilla de aportar contenido nuevo.
- Comprueba que no exista ya. Busca en la web y en el mapa del contenido del repositorio.
- Crea la nota desde su plantilla (más abajo).
- Rellena el frontmatter completo y sigue la estructura de la plantilla.
- Abre un pull request con una frase que explique qué problema resuelve.
Para lecciones, sistemas o cambios de estructura, abre antes una incidencia y lo hablamos. Así no trabajas en algo que luego no encaja.
Estilo de la casa
- Español de España, tuteo, voz activa y frases cortas.
- Sin humo: nada de adjetivos de folleto, cifras sin fuente ni promesas.
- Explica cada término técnico la primera vez o enlázalo al glosario.
- Si algo depende, di de qué. Si cambia rápido (modelos, precios, límites), remite a la documentación oficial.
- Código mínimo y ejecutable, con el nombre del modelo en una sola constante. Las salidas inventadas van en un bloque
textque empieza con# salida de ejemplo. - Pocos avisos por página: dos o tres como mucho.
Usar las plantillas
La carpeta _plantillas/ tiene una plantilla por tipo de página: lección, artículo de docs, receta, término, patrón, sistema, entrada del radar y el resto. Cada una trae el frontmatter de su colección y las secciones que esperamos.
En Obsidian, crea una nota nueva y usa Insertar plantilla. Fuera de Obsidian, copia el archivo y sustituye los valores. Deja estado: borrador mientras escribes. La web no publica los borradores.
Flujo con Obsidian y git
git clone <url-del-repositorio>
cd <carpeta-del-repositorio>
pnpm install
git switch -c receta/reintentos-con-jitter- Abre la carpeta
contenido/como bóveda en Obsidian. Los enlaces[[ruta]]funcionan igual en Obsidian y en la web. - Escribe con la ruta completa en los enlaces, por ejemplo
[[glosario/rag]]. - Mira el resultado con
pnpm devenhttp://localhost:4321. - Pasa
pnpm validar. Comprueba el frontmatter y falla si hay enlaces a páginas que no existen. - Quita el
estado: borrador, haz commit y abre el pull request.
Licencia de lo que aportas
Al contribuir aceptas que tu texto se publique con la licencia del contenido (CC BY-SA 4.0) y tu código con la del código (MIT). Los detalles están en Licencia.
Código de conducta
- Trata a todo el mundo con respeto, sea cual sea su nivel.
- Critica el contenido, no a las personas.
- Las preguntas de principiante son bienvenidas.
- No se tolera el acoso, los insultos ni la discriminación. Esas aportaciones se cierran y sus autores pueden quedar fuera del proyecto.