escribiendo una guía

Antes de empezar

Si está buscando inspiración para escribir la guía, puede navegar por los temas abiertos del repositorio bitxor-docs para encontrar algunas ideas pendientes de escribir. También te animamos a unirte a la Discord server y preséntate en el canal #docs-general!

Para comenzar a trabajar en uno de los problemas existentes, indique su intención en un comentario para evitar la duplicación de esfuerzos. Si aún no hay ningún problema, cree uno nuevo (consulte contribute-suggestion) y luego comience a trabajar en él.

escribiendo la guía

1. Fork y clone el repositorio bitxor-docs.

   git clone https://github.com/bitxorcorp/bitxor-docs.git
   

2. Asegúrese de tener Python 3.4+ y pip instalado.

   python --version
   

3. Requisitos de instalación usando pip:

   pip install -r requirements.txt
   

4. Cree un nuevo archivo rst dentro de una de las carpetas de guías.

   mkdir source/guides/<folder_name>/<title>.rst
   

5. Escriba y codifique su guía en texto reestructurado. Si necesita ayuda para dar formato a su texto, puede consultar esta cheatsheet.

Puede utilizar la siguiente plantilla para organizar su contenido:

#####
Título
#####

El objetivo a lograr después de terminar la guía.

********
caso de uso
********

Explicar los conceptos necesarios antes de empezar a codificar.

************
requisitos previos
************

- A
- B
- C

*********************
Entrar en algo de código
*********************

Presentar el código y explicaciones paso a paso.

************
¿Que sigue?
************

¿Hay algún ejercicio adicional que los lectores puedan intentar por su cuenta?

6. Agregue ejemplos de código en source/resources/examples/<language_or_tool>. Puedes renderizar fragmentos de código desde un archivo dentro de tu archivo .rst con la directiva example-code.

   .. example-code::
   
      .. viewsource:: <relative_url>.ts
          :language: typescript
          :start-after:  /* start block 01*/
          :end-before: /* end block 01 */
   

7. Pruebe y obtenga una vista previa de sus cambios.

   make livehtml
   

8. Empuje sus cambios y cree una solicitud de extracción.

   No se preocupe si no lo hace todo bien en el primer intento. Los mantenedores del repositorio revisarán y editarán el contenido para seguir la guía de estilo de documentación.

Para obtener más información sobre el repositorio bitxor-docs, continúe leyendo la guía Documentación.