-
Notifications
You must be signed in to change notification settings - Fork 10
Contributing with the docs es
Resumiendo las cosas:
- Inicia sesión en tu cuenta de github (o crea una cuenta si no cuentas con una).
- Edita una pagina (o crea una nueva) en la RAwiki. Tienes que utilizar el lenguaje de marcado Markdown (mas información mas abajo).
- Tarde o temprano un moderador va a generar las paginas para RAdocs.
La diferencia entre RAwiki y RAdocs es explicada en Como funciona la documentación de RA.
Markdown es un lenguaje de marcado extremadamente ligero y fácil de aprender con una sintaxis de formateado de texto simple. Para contribuir en nuestro proyecto tienes que mínimo conocer los básicos de markdown. Aqui hay una buena pagina de referencia: http://commonmark.org/help/, y aquí puedes probar 10 minutos del tutorial.
Ademas, esta wiki necesita ser escrita en cierto formato para que así se puedan convertir en las bonitas paginas estáticas de ya conoces. Esto es debido a que utilizamos mkdocs) y este utiliza el markdown de python y github utiliza el markdown de github, entonces hay algunos pequeños problemas de formato que se tienen que tomar en cuenta.
Los títulos (definidos por un #
) necesitan seguir una progresión natural de la jerarquía del contenido de la pagina. Pero tu NO PUEDES dos encabezados de titulo (esos que tienen solamente un símbolo de #
). De otra manera no se mostraran en la tabla de contenidos a la derecha de la pagina
Ej.
# Titulo
## Encabezado principal uno
### Sub Encabezado uno
### Sub Encabezado dos
## Encabezado Principal dos
etc.
Los enlaces tienen que seguir la siguiente sintaxis
[Enlace](ruta del enlace)
Nota: Si este es un enlace a otra pagina de la wiki esto se hace con una ruta relativa:
[Tips y Trucos](Tips-and-Tricks-es)
NO utilices el URL completo cuando estés linkeando a otra pagina de la wiki, como esto (si, este es un ejemplo de lo que NO tienes que llegar a hacer):
[Tips y Trucos](https://github.com/RetroAchievements/docs/wiki/Tips-and-Tricks-es)
Enlaces para imágenes tienen que seguir la misma sintaxis que el ejemplo de abajo:
![Imagen](http://url/a.png)
Nota:: Si quieres llegar a almacenar imágenes para este proyecto de documentación, puedes publicarlas en este tema de aquí y utilizar el hack de almacenamiento de imágenes de github.
Una tabla simple se mira de esta manera:
Primer Encabezado | Segundo Encabezado | Tercer Encabezado
--------------------- | ---------------------- | ---------------------
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda
Y se debería de renderizar de esta manera:
Primer Encabezado | Segundo Encabezado | Tercer Encabezado |
---|---|---|
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda |
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda |
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda |
Puedes especificar una formación en especifico por cada columna agregando dos puntos a las lineas del separador:
Primer Encabezado | Segundo Encabezado | Tercer Encabezado
:--------------------- | :----------------------: | ---------------------:
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda
Resultado:
Primer Encabezado | Segundo Encabezado | Tercer Encabezado |
---|---|---|
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda |
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda |
Contenido de la Celda | Contenido de la Celda | Contenido de la Celda |
- User Guidelines
- Developer Guidelines
- Content Guidelines
- FAQ
- Setup Guide
- Emulator Support and Issues
- Ways to Contribute
- RABot, the RA Discord Robot
- Events
- Overlay Themes
- Useful Links
- Contributing with the docs
- About Us
- Tutorials
- Developer Docs
- How to Become an Achievement Developer
- Getting Started as an Achievement Developer
- Game Identification
- Achievement Design
- Achievement Scoring
- Difficulty Scale and Balance
- Progression and Win Condition Typing
- Badge and Icon Creation
- Achievement Development Overview
- Flags
- BitCount Size
- Alt Groups
- Hit Counts
- Delta Values
- Prior Values
- Value Definition
- Condition Syntax
- Minimum Required Versions for Logic Features
- Memory Inspector
- Real Examples
- Set Development Roadmap
- Achievement Templates
- Tips and Tricks
- Leaderboards
- Rich Presence
- RATools
- Console Specific Tips
- Emulator Hotkeys for Developers
- libretro core support
- Docs To Do List
- WIP User Code of Conduct
- WIP CoC FAQ
- WIP Content Guidelines
- WIP-Jr
- WIP---Dev-Tips---Code-Notes-En-Masse
- WIP-‐-Reauthorship-Policy
- Manifesto RetroAchievements
- Código de Conduta do Usuário
- FAQ - Perguntas Frequentes
- Como contribuir se você não é um desenvolvedor
- Tutorial para Jogos Multi-Discos
- Introdução
- Primeiros Passos como um Desenvolvedor de Conquistas
- Recursos de Lógica para Achievements
- Exemplos Reais
- Dicas e Truques
- Dicas Específicas de Console
- Modelos de Achievement
- Escala de Dificuldade e Equilíbrio
- Roteiro de Desenvolvimento de um Set de Conquistas
- Criação de Ícones e Emblemas
- Leaderboards
- Rich Presence
- Design de Conquistas
- Manifesto RetroAchievements
- Código de Conducta del Usuario
- FAQ - Preguntas Frecuentes
- Tablas Globales y Reglas para la Casería de Logros
- Mi juego no esta cargando los logros
- Como contribuir si no eres un desarrollador
- Por que no deberías utilizar la función de cargar estado
- Contribuyendo con los documentos
- Como funciona la Documentación de RA
- Descargas
- Intro
- Código de Conducta del Desarrollador
- Como convertirme en un Desarrollador de Logros
- Primeros pasos como un Desarrollador de Logros
- Un vistazo al Inspector de Memoria
- Características en la Logica de un Logro
- Ejemplos Reales
- Intro
- Utilizando Hit Counts como un Temporizador
- Utilizando Valores Delta y Hit Counts para Detectar un Incremento
- Un Ejemplo Simple en como evitar el Abuso de Estados de Guardado
- Evitar el Problema de que un Contador se Incremente Dos Veces en el Mismo Frame
- Creando un Temporizador con un ResetIf Hits basándote en la Velocidad de un Juego
- Plantillas para Logros
- Tips y Trucos
- Escala de Dificultad y Balance
- Diseño de Logros
- Mapa de Desarrollo de Set
- Revisiones en Set de Logros
- Creación de Iconos y Badges
- Tablas de Clasificación
- Rich Presence
- Trabajando con el ROM apropiado
- Identificación del Juego
- Guía para Sets Bonus
- Logros para ROM hacks
- Tips Específicos por Consola