starknet docs

Repositorio de documentación de Starknet

El sitio web de Starknet Docs, https://docs.starknet.io, está escrito en ASCIIDOC y se construye con Antora, un generador de sitios web estático para AsciIDoc.

Contribuyendo a la documentación de Starknet

Si está interesado en contribuir a la documentación técnica de Starknet, la siguiente tabla proporciona enlaces rápidos para ayudarlo a comenzar.

Pregunta	Recurso
Estoy interesado, ¿cómo contribuyo?	Para obtener información sobre cómo puede contribuir, consulte diferentes formas de contribuir.
¿Hay alguna pauta básica que me ayude?	Para las pautas básicas para ayudarnos a mantener nuestro contenido consistente, consulte las pautas de documentación.
¿Hay una guía de estilo y una guía de escritura que debería usar?	Consulte la Guía de estilo complementario de documentación de Starknet.
¿Cómo configura mi estación de trabajo?	Vea la configuración de su entorno.

Diferentes formas de contribuir

Hay algunas formas diferentes en que puede contribuir a la documentación de Starknet:

• Crea un problema de GitHub.

• Envíe una solicitud de extracción (PR). Puede crear un clon local de su propio tenedor del repositorio de Starknet-Docs, realizar sus cambios y enviar un PR. Esta opción es mejor si tiene cambios sustanciales o para ayudar a los cambios que desea agregar más rápidamente.

¿Qué sucede cuando envías un PR?

Cuando envía un PR, el equipo de Starknet Docs revisa las relaciones públicas y organiza más revisiones técnicas según sea necesario. Si el PR requiere cambios, los revisores agregan comentarios al PR. Podríamos solicitar que realice los cambios, o le haga saber que incorporamos su contenido en un PR diferente. Ocasionalmente, podríamos agregar compromisos al PR original directamente. Cuando se ha revisado el PR y todas las actualizaciones están completas, el equipo de documentación fusiona el PR y lo aplica a las versiones válidas.

Consejos sobre autoridad

• Guía de estilo complementario de documentación de Starknet: orientación general de estilo y guía de escritura.

Para obtener información sobre la escritura en ASCIIDOC, consulte:

• Documentación del idioma asciidoc

• Referencia rápida de sintaxis asciidoc

Nota

Existen múltiples formas de codificar ID, bloques de código fuente, referencias cruzadas y enlaces. En general, utilizamos las convenciones de codificación más explícitas para la codificación para priorizar la legibilidad del código. La mayoría de estas convenciones de codificación se enumeran en la referencia rápida de Mark-Up ASCIIDOC para la documentación de Red Hat

Antes de comenzar

1. Instale yarn si aún no está instalado.

2. Instale npx si aún no está instalado.

3. Clone este repositorio, ya sea de una bifurcación, o si usted es un colaborador oficial, entonces directamente de starknet-io/starknet-docs .

4. Cambiar al directorio de starknet-docs .

5. Ejecute el comando yarn para preparar el entorno:

    hilo

yarn debe preparar su entorno instalando los módulos requeridos basados ​​en package-lock.json y package.json . Si fue exitoso, debería poder construir y obtener una vista previa de contenido.

Construcción y vista previa de contenido localmente

Después de escribir o editar contenido, para obtener una vista previa de sus cambios:

1. Cree el contenido ejecutando el script build_local_site.sh de compilación:

   ./build_local_site.sh

   Este comando genera el sitio web en el directorio public_html .

2. Abra el sitio web haciendo uno de los siguientes:

   • Abra la página de inicio: <repo_root>/public_html/index.html .

   • Ejecute el servidor HTTP empaquetado con Antora:

     npx http-server public_html -c-1

     El servidor se ejecuta y le brinda una o más URL locales que puede usar para ver el sitio web. Por ejemplo:

     Starting up http-server, serving public_html
     
     ...
     
     Available on:
       http://127.0.0.1:8080
       http://192.168.68.111:8080
       http://192.168.14.3:8080
       http://10.14.0.2:8080
     Hit CTRL-C to stop the server

Lanzar documentos de Starknet en Github (solo para administradores)

El proceso de alto nivel para publicar cambios de documentación en este repositorio.

Durante el curso del desarrollo de contenido, los escritores fusionan las ramas con los cambios directamente en main , en una rama secundaria según sea necesario, donde estos cambios esperan hasta que estemos listos para liberarlos, es decir, publíquelas en docs.starknet.io.

Las acciones de GitHub crean etiquetas y lanzamientos Git que aparecen en las páginas de lanzamiento y etiquetas del repositorio.

Cuando una rama de características se fusiona en la rama main , una acción de GitHub crea una etiqueta de lanzamiento en el formato v<version>.<major_update>.<minor_update> y actualiza CHANGELOG.md . Luego publica el nuevo contenido a docs.starknet.io.

Procedimiento

Fusionar una rama de características a main publica automáticamente cambios en la rama de funciones. No se requieren pasos adicionales.

GitHub incrementa los números de versión en package.json y package-lock.json , y actualiza CHANGELOG.md con las descripciones de cada PR que se fusionó en main . . Actualice su rama main local desde la rama main remota utilizando uno de los siguientes:

• Trae los cambios:

  starknet-docs (main) git pull

• Haga un Rebase de [email protected]:starknet-io/starknet-docs.git :

  starknet-docs (main) git fetch origin
  starknet-docs (main) git rebase origin/main

  Nota	Si está utilizando una bifurcación, su repositorio bifurcado es origin de forma predeterminada, en cuyo caso debe asignar el nombre upstream a [email protected]:starknet-io/starknet-docs.git . Entonces, cuando se rebote, use upstream en lugar de origin en los comandos anteriores.