Referencia
Escribir estos docs
Cada página es un fichero Markdown en apps/docs/content. Así se añade una y así se usan sus piezas.
Los docs viven en el repositorio, en apps/docs/content. Cada página es un fichero .mdx: Markdown con unas pocas piezas de la interfaz de Forjar. Se editan como cualquier otro fichero y se publican con el siguiente despliegue.
Añadir una página
Crea el fichero
La carpeta es la sección y el nombre es la dirección: content/usar/rutinas.mdx se publica en /usar/rutinas, dentro de «Usar Forjar». Un index.mdx es la página de su carpeta.
Escribe el frontmatter
---
title: Rutinas
description: Una línea que dice qué resuelve la página.
order: 9
sidebar: Rutinas
---title es obligatorio. description va bajo el título y en los buscadores. order la coloca en su sección (menor, antes). sidebar es un título más corto para el índice.
Escribe la página
Markdown normal: ## y ### aparecen en «En esta página» y en el buscador. Los enlaces entre páginas son rutas: [Política](/usar/politica).
Una sección nueva es una carpeta y una línea en content/sections.json, que fija el orden de las secciones del índice.
Cómo escribimos
- Frases cortas, verbo primero. Una idea por frase.
- Tuteo. Sin exclamaciones, sin emojis, sin «potenciado por IA».
- Pasos numerados y comandos copiables. Sin adjetivos.
- Lo que no está verificado o no existe todavía se dice.
- «Equipo», nunca «organización». El producto se llama «Forjar», con erre.
- Nunca un secreto real, ni en un ejemplo.
Las piezas
Callout
Forjar dice algo: una nota, un aviso o un peligro.
<Callout>Una nota.</Callout>
<Callout tone="warning">Un aviso.</Callout>
<Callout tone="danger">Algo que se pierde si no se hace.</Callout>Steps
Cada ### dentro es un paso numerado.
<Steps>
### Primer paso
Texto.
### Segundo paso
Texto.
</Steps>Tabs
Una pestaña por <Tab>, con las etiquetas de items en el mismo orden. Lo normal es separar cloud y self-hosted.
<Tabs items={["Cloud", "Self-hosted"]}>
<Tab>
Lo que cambia en cloud.
</Tab>
<Tab>
Lo que cambia en self-hosted.
</Tab>
</Tabs>Lo que cambia en cloud.
Cards
Enlaces a otras páginas, en rejilla.
<Cards>
<Card href="/cloud" title="Cloud">Una línea sobre la página.</Card>
<Card href="/self-hosted" title="Self-hosted">Otra.</Card>
</Cards>Badge
Una etiqueta corta: alpha verificado. Tonos: neutral, brand, success, warning, danger e info.
Verlo en local
pnpm --filter docs dev # http://localhost:5173
pnpm --filter docs build # una página HTML por cada .mdx, en apps/docs/dist