Este repositorio contiene el código fuente de la documentación del creador en create.roblox.com/docs.
Nota : Actualmente, el repositorio cuenta con guías, tutoriales, contenido educativo y la referencia de Engine API. Próximamente llegarán ejemplos de código.
Si no está familiarizado con el proceso de contribución de GitHub, consulte Acerca de las solicitudes de extracción y el siguiente video.
Si encuentra un problema con la documentación y no desea enviar una solicitud de extracción, háganoslo saber informándolo en los foros de desarrolladores de Roblox.
Cualquier adición a la documentación del creador de Roblox debe encajar dentro del todo mayor. En otras palabras, incluso una publicación de blog o un documento técnico completo, preciso y bien escrito puede no tener cabida en el sitio web.
En términos generales, buscamos contenido que se ajuste a nuestros estándares existentes y se aplique a una amplia variedad de experiencias y casos de uso. Por ejemplo, preferimos páginas como Creación de interfaces de usuario a páginas como Creación de un velocímetro para un juego de carreras . Considere publicar guías más especializadas en el foro de desarrolladores de Roblox.
Cuando envía una solicitud de extracción para revisión, debe aceptar lo siguiente:
Esta contribución fue creada total o parcialmente por mí y tengo derecho a enviarla según los términos de las licencias de código abierto de este repositorio.
Entiendo y acepto que esta contribución y un registro de la misma son públicos, se mantienen indefinidamente y pueden redistribuirse según los términos de las licencias de código abierto de este repositorio.
Hasta donde yo sé, todos los cambios propuestos son precisos.
Para cambios simples que solo afectan a un único archivo, use el editor basado en web de GitHub:
Busque el archivo en content/en-us/ y haga clic en Editar este archivo .
Haga clic en Bifurcar este repositorio .
Realice sus cambios y haga clic en Confirmar cambios....
Déle a su cambio un mensaje de confirmación descriptivo y haga clic en Proponer cambios .
Asegúrese de que el repositorio base sea Roblox/creator-docs y que la rama base sea main . Verifique que esté satisfecho con los cambios y haga clic en Crear solicitud de extracción .
Finalmente, complete los detalles en la descripción de la solicitud de extracción y haga clic en Crear solicitud de extracción .
Para cambios más importantes que afectan a varios archivos, recomendamos github.dev, un editor de texto con más funciones basado en Visual Studio Code que se ejecuta en su navegador:
Bifurca el repositorio.
Mientras navega por su bifurcación, presione el botón . clave para abrir github.dev.
En el menú Control de código fuente , haga clic en ... > Rama > Crear rama... .
Asigne un nombre a la sucursal y haga clic en Cambiar a sucursal .
Utilice el menú del Explorador para buscar los archivos que desea actualizar en content/en-us y realice los cambios que desee.
En el menú Control de fuente , verifique que esté satisfecho con los cambios.
Agregue un mensaje de confirmación y haga clic en Confirmar y enviar .
En una nueva pestaña del navegador, navegue hasta github.com/Roblox/creator-docs.
Haga clic en Comparar y solicitar extracción .
Verifique que el repositorio base sea Roblox/creator-docs y que la rama base sea main . El repositorio principal debe ser su bifurcación y su rama.
Finalmente, complete los detalles en la descripción de la solicitud de extracción y haga clic en Crear solicitud de extracción .
Alternativamente, puede usar los menús de GitHub o GitHub Pull Request en github.dev para enviar la solicitud de extracción. Para obtener documentación sobre el uso de github.dev, consulte GitHub Codespaces.
Este repositorio es extremadamente grande, por lo que recomendamos utilizar las opciones en línea siempre que sea posible. Sin embargo, si ya está familiarizado con el flujo de trabajo general de GitHub y desea utilizar un editor de texto sin conexión, estos son los pasos básicos para contribuir a la documentación:
Configura Git y Git LFS. Alternativamente, instale un cliente Git como GitHub Desktop.
Bifurca este repositorio.
Clona tu tenedor.
Navegue hasta la raíz del repositorio.
Crea una nueva rama.
Realice los cambios que desee.
Confirme, presione su bifurcación y envíe su solicitud de extracción en la rama main de este repositorio.
Para conocer pasos más detallados, consulte CONTRIBUTING.md.
La documentación de Roblox tiene tres tipos de documentos principales:
Guías conceptuales y basadas en tareas en archivos .md en content/en-us/
Las guías le enseñan sobre una función o flujo de trabajo sin ser demasiado prescriptivas sobre el resultado final. Introducen conceptos y características y cubren las tareas que puede realizar utilizando diversas herramientas u otros enfoques.
Las guías se benefician enormemente de casos de uso, imágenes, fragmentos de código y diagramas prácticos del mundo real. La mayoría del contenido basado en tareas debe incluir una lista numerada.
Documentos de referencia de API en archivos .yaml en content/en-us/reference
Las API son contenido enteramente de referencia y deben utilizar descripciones funcionales, vinculando a guías cuando corresponda. Más que otros tipos de contenido, el contenido de referencia debe ser conciso y directo; Los resúmenes de propiedades, métodos, eventos y devoluciones de llamadas no necesitan ser oraciones completas.
Tutoriales en archivos .md en content/en-us/tutorials
En comparación con las guías basadas en tareas, los tutoriales son más autónomos y le llevan de la nada a algo . Este enfoque en crear algo específico significa que normalmente son mucho más prescriptivos que las guías. Los tutoriales suelen abordar múltiples funciones y conceptos al mismo tiempo, demostrando las conexiones entre herramientas y estrategias.
Si su contribución no encaja dentro de estas categorías o cubre un tema particularmente específico, es posible que no sea adecuada para la documentación. Considere publicarlo en el foro de desarrolladores de Roblox.
Intente limitar sus ediciones a una clase o característica para que la solicitud de extracción sea más fácil de revisar. Las correcciones de errores y las mejoras más pequeñas tienen una mayor probabilidad de aprobación rápida. Las guías grandes a menudo requieren importantes idas y venidas antes de su publicación.
Para evitar problemas de formato, recomendamos editores de texto como github.dev que te permiten obtener una vista previa de Markdown mientras lo escribes. Para la prosa, intente seguir las pautas de STYLE.md. Para ver ejemplos de código, utilice la Guía de estilo de Lua.
Para ver una página completamente formateada según lo que vemos en la rama main , reemplace la URL completa desde content/ y antes. A los archivos con el index de nombre base se les debe eliminar ese nombre. Por ejemplo, la página de "https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md" se representa en "https://create.roblox.com /docs/en-us/avatar".
Para la prosa, este proyecto utiliza la Licencia Pública Internacional Creative Commons Attribution 4.0. Para obtener el texto completo de la licencia, consulte LICENCIA.
Hay ejemplos de código disponibles bajo la licencia MIT. Para obtener el texto completo de la licencia, consulte CÓDIGO DE LICENCIA.
Para mantener una comunidad abierta, acogedora, diversa, inclusiva y saludable, este proyecto aplica una versión adaptada del Pacto del Colaborador. Para obtener más información, consulte CODE_OF_CONDUCT.md.
