Imported from feispla/docs (
AGENTS.md). Install upstream withnpx skills add feispla/docs. Copyright stays with the author.
Instrucciones del proyecto de documentación de VANTS
Sobre este proyecto
- Documentación interna de VANTS GAMES, plataforma de esports, construida con Mintlify.
- Este repositorio es
feispla/docs. Cada cambio en la ramamainse publica en https://vantsgg.mintlify.app. - Las páginas son archivos MDX con frontmatter YAML. La configuración y la navegación están en
docs.json. - El código que se documenta está en la organización VANTSNET de GitHub: Playvants-web, vants-dev-launcher, VantsSeguridad, VantsBasededatos, vants-clips y vants-faceit-webhook.
- Servidor MCP de esta documentación:
https://vantsgg.mintlify.app/mcp. Índice para LLMs:https://vantsgg.mintlify.app/llms.txt. - Para dudas sobre Mintlify (componentes,
docs.json, frontmatter), usa su servidor MCP de documentación,https://www.mintlify.com/docs/mcp, o instala su skill connpx skills add https://mintlify.com/docs.
Estructura
| Ruta | Contenido |
|---|---|
index.mdx |
Portada con enlaces a todo el sitio |
mapa-del-codigo.mdx |
Qué repositorio y qué archivo tocar para cada cambio |
arquitectura.mdx |
Componentes, despliegues y decisiones de diseño |
glosario.mdx |
Prefijos, siglas y nombres propios |
agentes.mdx |
Servidor MCP, llms.txt y reglas para agentes |
repos/ |
Una página por repositorio |
referencia/ |
API pública, esquema de la base de datos, bot de Discord y seguridad |
Terminología
- Escribe "VANTS" en mayúsculas. El nombre completo de la marca es "VANTS GAMES".
- Usa el nombre exacto de cada repositorio: Playvants-web, vants-dev-launcher, VantsSeguridad, VantsBasededatos, vants-clips y vants-faceit-webhook.
- El bot de Discord se llama VANTCALL. En algunos README aparece como ORION.
- "El Worker" es el Worker de Cloudflare
vants, que sirve la web y la API. "Neon Functions" son las funciones deneon-functions/. - Los prefijos de tabla (
pt_,mm_,agent_), las siglas y el resto de nombres internos están englosario.mdx. Si añades un término nuevo, defínelo allí.
Estilo
- Escribe en español y trata al lector de tú.
- No uses la raya (U+2014) ni la semirraya (U+2013). Reescribe la frase o usa una coma, dos puntos o paréntesis. Los rangos se escriben "de X a Y".
- Cada página empieza con un párrafo que dice qué cubre, antes del primer encabezado.
- Frontmatter obligatorio:
title(60 caracteres como máximo),sidebarTitle(de 1 a 3 palabras),description(de 130 a 160 caracteres, única y sin repetir el título) ykeywords. - Encabezados con mayúscula solo en la primera palabra y en los nombres propios.
- Formato de código para archivos, rutas, comandos, tablas, variables y nombres de workflows.
- Usa tablas para rutas, campos, variables y workflows.
- Enlaces internos con ruta absoluta desde la raíz y sin extensión, por ejemplo
/referencia/api-publica. - Si renombras o mueves una página, actualiza los enlaces que apuntan a ella y añade una redirección en
docs.json.
Fuente de verdad
- El código de cada repositorio manda. No inventes rutas, tablas, columnas, comandos ni variables: compruébalos en el código antes de escribirlos.
- Si el código y una página no coinciden, corrige la página.
Límites del contenido
- Nunca publiques vulnerabilidades, fallos de seguridad ni hallazgos de auditoría. Se comunican en privado al equipo.
- Nunca publiques secretos, tokens ni cadenas de conexión. Como mucho, el nombre de la variable que los guarda.
- Describe la seguridad a nivel de concepto, como en
referencia/seguridad.mdx.
