Passer au contenu principal
Version: bleeding-edge 🩸

🤝 Contribuer à la documentation

Bonjour Dyno! Bonjour Markdown!

Cette documentation est faite avec Docusaurus et écrite en Markdown ! N'hésitez pas à suggérer des modifications et à modifier les pages sur GitHub, cette aide est vraiment important pour nous et nous apprécions réellement ceux qui aident à l'écrire !

Suggérer des Modifications​

Vous pouvez proposer des modifications directement sur GitHub avec le bouton Edit this Page en bas à gauche de chaque page : faites votre suggestion et ouvrez une Pull Request ! Une fois acceptée, votre suggestion est immédiatement appliquée à la version bleeding-edge des docs !

Lancer la documentation en local​

Pour prévisualiser vos changements avant d'ouvrir une Pull Request, clonez le dépôt de la documentation avec ses sous-modules (l'API en est un) et lancez-le avec Node.js et Yarn :

Terminal
git clone --recurse-submodules https://github.com/nanos-world/docs.git
cd docs
yarn install
yarn start

La documentation s'ouvre sur http://localhost:3000 et se recharge à chaque modification des fichiers.

Où modifier​

  • docs/ est la version bleeding-edge de la documentation, qui suit les dernières mises à jour du jeu. La plupart des modifications se font ici.
  • versioned_docs/version-latest/ est la version stable. Ne la modifiez que pour corriger une erreur qui existe aussi dans la version stable actuelle du jeu.
  • blog/ contient les articles d'actualité.
  • src/api/ est un sous-module qui contient les fichiers JSON de l'API (voir plus bas).

Conseils de rédaction​

  • Chaque titre se termine par une ancre explicite, comme ## My Heading {/* #my-heading */}, pour que les liens fonctionnent aussi dans les pages traduites. Lancez yarn write-heading-ids pour les générer.
  • Faites vos liens vers les autres pages avec leur chemin de fichier, par ex. [Packages Guide](/core-concepts/packages/packages-guide.mdx).
  • Utilisez les composants intégrés pour référencer l'API, comme <Classes.Character />, <StaticClasses.Server />, <MethodReference type="Class" class_name="Actor" method_name="SetLocation" /> et <EventReference type="Class" class_name="Character" event="Death" />.
  • Indiquez le côté dans le titre des blocs de code Lua (par ex. ```lua title="Server/Index.lua") : cela aide les lecteurs à savoir où le code s'exécute.

Référence de l'API​

Nos Docs sont intelligents ! La section Scripting Reference est générée automatiquement à partir de notre dépôt d'API JSON sur GitHub. Nous avons défini toutes les classes, méthodes et événements en JSON qui peuvent être analysés dans n'importe quel format !

Pour proposer une modification de description ou corriger une coquille, passez donc par les dossiers de notre dépôt d'API : Classes, StaticClasses, Structs, UtilityClasses, StandardLibraries ou Enums !

Traduction des pages​

Par défaut, toutes les pages sur GitHub sont en anglais et toutes les traductions proviennent de Crowdin. Rendez-vous sur la page Crowdin officielle de la documentation de nanos world pour nous aider à traduire dans toutes les langues disponibles ! Vous pouvez demander d'autres langues ! Merci de nous faire savoir si vous voulez nous aider dans une nouvelle langue !

Crowdin