Saltar al contenido principal

Guía de estilo de contenido

Todos los niveles

La coherencia es lo que hace que una referencia resulte fiable. Sigue estas pautas y tu PR pasará la revisión sin problemas.

Tono​

  • Claro y directo. Frases cortas. Empieza por lo importante.
  • Cercano, nunca relleno. Elimina "en el mundo acelerado de hoy". Respeta el tiempo del lector.
  • Categórico y luego honesto. Da primero la única forma recomendada y luego señala las alternativas y los compromisos.
  • Ejemplos antes que teoría. Muestra un fragmento o un caso concreto; no te limites a describir.
  • Inglés estadounidense.

Estructura de una página​

---
sidebar_position: 2
title: "Your Page Title"
description: "One sentence for search and previews."
---

<LevelBadge level="beginner" />

A one or two sentence intro that states what the reader will get.

## Sections with ## headings
...

## Next
- 2–4 links to related pages
  • Empieza con la insignia de nivel (beginner | intermediate | advanced | all). Los componentes son globales — no los importes.
  • Termina con una lista "Next" / "Related" de 2 a 4 enlaces internos.
  • Usa admoniciones (:::tip, :::warning, :::note, :::info) para enfatizar, con moderación.

Las dos reglas inquebrantables​

:::warning No negociable

  1. Cita las fuentes de los datos volátiles. Nombres de modelos, precios, límites, flags exactos, funciones en beta → enlaza la fuente oficial y añade <VerifyNote lastVerified="YYYY-MM-DD" source="…">. Nunca codifiques datos de modelos a mano — enlaza a la tabla de modelos. Detalles: Verificación de hechos.
  2. No inventes. Nada de estadísticas, citas, APIs o funciones inventadas. Si no estás seguro, dilo o marca [verify]. :::

Opinión frente a oficial​

  • Somos categóricos — ese es el valor. Recomienda, no te limites a enumerar.
  • Pero la documentación oficial es la fuente de la verdad. Defiérele, enlaza a ella y nunca la contradigas en silencio.

Trampas de MDX​

  • Las llaves {como estas} en la prosa las interpreta MDX como código — ponlas entre comillas invertidas o en bloques de código, o usa [corchetes] en los ejemplos.
  • Pruébalo en local: npm run build debe pasar (falla con los enlaces rotos).

Siguiente​