Descripción general

¡Las contribuciones a la documentación son bienvenidas! Esta guía explica cómo contribuir a la documentación de LibreChat escribiendo y dando formato a nueva documentación. El sitio web está construido con Fumadocs y los docs utilizan el formato .mdx.

Cuándo escribir un documento frente a una entrada de blog

Primeros pasos

• Haz un fork del repositorio de documentación de LibreChat: https://github.com/LibreChat-AI/librechat.ai

• Crea una rama en tu fork, asígnale un nombre adecuado y vincúlala al repositorio original.

git clone -b branch-name https://github.com/username/librechat.ai.git

Reemplace branch-name y username con sus detalles

Creación de nuevos documentos

Para crear un nuevo documento:

• Utilice la extensión de archivo .mdx (consulte la documentación de MDX para obtener más información).
• Nombre los archivos usando letras minúsculas y guiones bajos (por ejemplo, documentation_guidelines.mdx).
• Coloque los nuevos documentos en la carpeta/subcarpeta correspondiente dentro de content/docs.
• Agregue el documento al arreglo pages en el archivo meta.json de la carpeta donde se encuentra su documento. Si no lo agrega, Fumadocs aún podrá descubrirlo, pero no aparecerá en el orden previsto en la barra lateral.

Pautas de formato Markdown

• Utiliza encabezados y subencabezados con #, ## y ###.
  • Utilice # para el título del documento (solo se permite un título principal por documento).
  • Use ## para las secciones principales.
  • Utilice ### para subsecciones dentro de una sección.
• Utilice ** para poner el texto en negrita y resaltar información importante (no lo utilice en lugar de un encabezado).
• Utilice rutas de URL para enlazar a otros documentos (por ejemplo, /docs/documentation apunta al doc actual).
• Puedes usar HTML, TS y JS para añadir funciones adicionales a un documento.
• Asegúrate de que cualquier HTML tenga etiquetas de cierre (por ejemplo, <img src="" /> o <a href="link"></a>).
• No utilice comentarios HTML; en su lugar, utilice comentarios de Markdown solo si el texto está realmente oculto.

Recursos de documentación

Metadatos del documento

Agregue metadatos al encabezado de su documento utilizando el siguiente formato:

Nota: El campo ogImage es opcional y puede omitirse por completo. Se utiliza para especificar la imagen que se mostrará al compartir su documento en plataformas de redes sociales.

---
title: Document Title
description: This description will be used in social cards and search engine results.
ogImage: /images/docs/<category>/image.png (optional)
---

Recursos

Siempre que sea posible, suba los recursos (por ejemplo, imágenes) a GitHub en lugar de almacenarlos en la carpeta /public. Esto ayuda a mantener su repositorio organizado y facilita la gestión de sus recursos.

Imágenes

Para capturas de pantalla que deban adaptarse al tema activo, utiliza el componente ThemeImage. Proporciona una fuente light y dark y este renderizará la variante que coincida con el tema del lector. También admite hacer clic para ampliar, al igual que cualquier otra imagen.

vea el siguiente ejemplo en acción aquí: Guías de usuario

<ThemeImage
  light="https://github.com/danny-avila/LibreChat/assets/32828263/cf0f3231-287a-407f-bd4d-3d5bad94e893"
  dark="https://github.com/danny-avila/LibreChat/assets/32828263/a03ee02d-5099-4220-95b0-bfa2d3b00b4d"
  alt="LibreChat running on an iPad"
/>

Cómo subir imágenes y videos a GitHub

Probar la documentación