starknet docs

Référentiel de documentation StarkNet

Le site Web de Starknet Docs, https://docs.starknet.io, est écrit en Asciidoc et est construit à l'aide d'Antora, un générateur de sites Web statique pour ASCIIDOC.

Contribuant à la documentation StarkNet

Si vous souhaitez contribuer à la documentation technique de StarkNet, le tableau suivant fournit des liens rapides pour vous aider à démarrer.

Question	Ressource
Je suis intéressé, comment puis-je contribuer?	Pour plus d'informations sur la façon dont vous pouvez contribuer, voir différentes façons de contribuer.
Y a-t-il des directives de base pour m'aider?	Pour que les directives de base nous aident à garder notre contenu cohérent, voir les directives de documentation.
Y a-t-il un guide de style et un guide d'écriture que je devrais utiliser?	Voir le guide de style supplémentaire de documentation StarkNet.
Comment configurer mon poste de travail?	Voir la configuration de votre environnement.

Différentes façons de contribuer

Il existe différentes façons de contribuer à la documentation StarkNet:

• Créez un problème GitHub.

• Soumettre une demande de traction (PR). Vous pouvez créer un clone local de votre propre fourche du référentiel Starknet-Docs, effectuer vos modifications et soumettre un PR. Cette option est la meilleure si vous avez des changements substantiels ou pour aider les modifications que vous souhaitez ajouter plus rapidement.

Que se passe-t-il lorsque vous soumettez un PR?

Lorsque vous soumettez un RP, l'équipe de Docs Starknet examine le PR et organise d'autres avis techniques si nécessaire. Si le PR nécessite des modifications, les examinateurs ajoutent des commentaires au PR. Nous pourrions vous demander d'apporter les modifications, ou vous faire savoir que nous avons incorporé votre contenu dans un PR différent. À l'occasion, nous pourrions ajouter directement les validations au RP d'origine. Lorsque le PR a été examiné et que toutes les mises à jour sont terminées, l'équipe de documentation fusionne le PR et l'applique aux version valide.

Conseils sur la création

• StarkNet Documentation Guide de style supplémentaire: Guidance de style général et guidage de rédaction.

Pour plus d'informations sur l'écriture dans Asciidoc, voir:

• Documentation en langue asciidoc

• Référence rapide de la syntaxe Asciidoc

Note

Il existe plusieurs façons de coder les ID, les blocs de code source, les références croisées et les liens. En général, nous utilisons les conventions de codage les plus explicites pour le codage afin de hiérarchiser la lisibilité du code. La plupart de ces conventions de codage sont répertoriées dans une référence rapide de balisage Asciidoc pour la documentation du chapeau rouge

Avant de commencer

1. Installez yarn s'il n'est pas déjà installé.

2. Installez npx s'il n'est pas déjà installé.

3. Clone ce dépôt, soit à partir d'une fourche, ou si vous êtes un collaborateur officiel, alors directement à partir de starknet-io/starknet-docs .

4. Passez au répertoire starknet-docs .

5. Exécutez la commande yarn pour préparer l'environnement:

    fil

yarn doit préparer votre environnement en installant les modules requis en fonction de package-lock.json et package.json . Si cela a réussi, vous devriez pouvoir créer et prévisualiser du contenu.

Construire et prévisualiser le contenu localement

Après avoir écrit ou modifié le contenu, pour prévisualiser vos modifications:

1. Build le contenu en exécutant le script de construction build_local_site.sh :

   ./build_local_site.sh

   Cette commande génère le site Web dans le répertoire public_html .

2. Ouvrez le site Web en faisant l'un des éléments suivants:

   • Ouvrez la page Démarrer: <repo_root>/public_html/index.html .

   • Exécutez le serveur HTTP emballé avec Antora:

     npx http-server public_html -c-1

     Le serveur s'exécute et vous donne une ou plusieurs URL locales que vous pouvez utiliser pour afficher le site Web. Par exemple:

     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

Sortir des documents StarkNet sur GitHub (pour les administrateurs uniquement)

Le processus de haut niveau pour libérer des changements de documentation dans ce référentiel.

Au cours du développement de contenu, les écrivains fusionnent les branches avec des modifications directement en main , dans une branche secondaire au besoin, où ces changements attendent que nous soyons prêts à les libérer - c'est-à-dire les publier sur docs.starknet.io.

Les actions GitHub créent des balises et des versions GIT qui apparaissent dans les pages des versions et des balises du repo.

Lorsqu'une branche de fonctionnalité est fusionnée dans la branche main , une action GitHub crée une balise de version dans le format v<version>.<major_update>.<minor_update> et met à jour CHANGELOG.md . Il publie ensuite le nouveau contenu sur docs.starknet.io.

Procédure

La fusion d'une succursale de fonctionnalités sur main publie automatiquement des modifications dans la branche des fonctionnalités. Aucune étape supplémentaire n'est requise.

GitHub incrémente les numéros de version dans package.json et package-lock.json , et met à jour CHANGELOG.md avec les descriptions de chaque PR qui vient d'être main . . Mettez à jour votre branche main locale de la branche main distante à l'aide de l'une des éléments suivants:

• Tirez les changements:

  starknet-docs (main) git pull

• Faites une rebase de [email protected]:starknet-io/starknet-docs.git :

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

  Note	Si vous utilisez une fourche, votre dépôt de fourche est origin par défaut, auquel cas vous devez attribuer le nom upstream à [email protected]:starknet-io/starknet-docs.git . Ainsi, lorsque vous reprochez, utilisez upstream au lieu de origin dans les commandes ci-dessus.