Editar y publicar documentación

Plataforma recomendada

VitePress + Cloudflare Pages permite mantener los contenidos en Markdown y publicar archivos estáticos. El sitio no necesita servidor de aplicación ni base de datos.

Cloudflare ofrece un plan gratuito para Pages. Los límites publicados incluyen 500 compilaciones mensuales y hasta 20 000 archivos por sitio en el plan Free. El dominio se compra y renueva por separado; compara el precio de renovación, no solo la oferta del primer año.

Fuentes: Cloudflare Pages, límites oficiales y dominios propios. Comprueba las condiciones actuales antes de contratar.

Trabajar localmente

Instala Node.js 20 o posterior y pnpm 11.19.0. Desde docs/greencore, ejecuta:

pnpm install --frozen-lockfile
pnpm docs:dev

Para generar el sitio:

pnpm docs:build
pnpm docs:preview

La salida publicable es .vitepress/dist. Publica esa salida, no los archivos internos ni el repositorio completo.

Añadir una página Markdown

1. Crea un archivo dentro de guia o referencia.
2. Escribe un único título principal y organiza el contenido con subtítulos.
3. Identifica el paquete requerido y explica el comportamiento antes del ejemplo.
4. Agrega el enlace en .vitepress/config.mts.
5. Ejecuta la compilación; los enlaces internos rotos deben corregirse antes de publicar.

Usa bloques de código etiquetados como csharp, shell o powershell. Incluye la salida esperada cuando sea determinista. Evita promesas de rendimiento, compatibilidad o publicación que no estén comprobadas.

Publicación con Cloudflare Pages

Secuencia de versiones NuGet

La versión inicial configurada es 0.0.1-alpha.1. Para las siguientes publicaciones cambia únicamente el sufijo: 0.0.1-alpha.2, 0.0.1-alpha.3 y así sucesivamente hasta 0.0.1-alpha.99. NuGet no permite reemplazar una versión que ya fue publicada, por lo que cada incremento debe publicarse una sola vez.

Puedes conectar tu repositorio desde el panel de Cloudflare o subir directamente la carpeta generada. No necesitas hacer público el código de la biblioteca para publicar el sitio estático.

Para integración con Git:

Ajuste	Valor
Directorio raíz	docs/greencore
Comando de compilación	pnpm docs:build
Directorio de salida	.vitepress/dist

Se incluye pnpm-lock.yaml: consérvalo en Git y utiliza pnpm install --frozen-lockfile para instalar en CI. Configura pnpm 11.19.0 en el entorno de compilación. Cloudflare ofrece una dirección inicial <proyecto>.pages.dev.

Conectar un dominio

Compra el dominio elegido y agrégalo primero en Custom domains del proyecto Pages. Para un subdominio como docs.tudominio.com, sigue la configuración CNAME indicada por Cloudflare. Un dominio raíz requiere la configuración de zona y servidores DNS descrita en la guía oficial.

El nombre del ejemplo no supone disponibilidad. El presupuesto final depende del dominio y de las condiciones del proveedor.

Qué incluye este sitio

Navegación lateral, índice por página, resaltado de C#, búsqueda local, enlaces entre guías y tema claro/oscuro. El contenido se modifica editando archivos .md; no hay un panel de carga de archivos ni gestión de usuarios.

Antes de publicar, sincroniza public/LICENSE.txt con la licencia de la raíz del repositorio. Una nueva página Markdown también debe revisarse como documentación técnica, no solamente como texto.