Bienvenue sur le dépôt officiel des documentations AyLabs ! Ce site a pour vocation de devenir la ressource de référence, centralisée et communautaire, pour tous les passionnés de Domotique et de Homelab.
Notre but est de fournir des guides, des astuces et des configurations toujours à jour, grâce à l'effort collectif.
- Centralisation : Regrouper toutes les connaissances de la chaîne AyLabs et de la communauté en un seul endroit facile d'accès.
- Open Source : Chaque article, chaque tutoriel est modifiable. La transparence est notre mot d'ordre.
- Actualité Garantie : Fini les guides obsolètes ! Le modèle communautaire garantit une mise à jour rapide lorsque les technologies évoluent.
Ces documentations vivent grâce à vous. Si vous détectez une erreur, si un outil a été mis à jour, ou si vous avez une meilleure méthode, votre contribution est essentielle !
Si vous trouvez une erreur, un lien cassé, ou une information manquante, veuillez ouvrir une Issue GitHub pour le signaler.
Vous souhaitez ajouter un nouveau guide ou corriger/améliorer un article existant ? Suivez ces étapes simples :
- Forkez ce dépôt.
- Clonez votre fork en local.
- Créez une nouvelle branche pour votre modification :
git checkout -b ma-super-contribution. - Effectuez vos modifications (les fichiers de documentation se trouvent principalement dans le dossier
docs/). - Testez en local (voir la section ci-dessous).
- Commitez vos changements et pushez-les sur votre fork.
- Ouvrez une Pull Request vers la branche
mainde ce dépôt.
Nous examinerons votre proposition dans les plus brefs délais !
Pour visualiser la documentation ou tester vos contributions avant de soumettre une PR, vous pouvez lancer le site Docusaurus en local.
- Node.js (version 18 ou supérieure recommandée)
- Yarn ou npm
-
Cloner le dépôt :
git clone https://github.com/AyLabsCode/docs cd docs -
Installer les dépendances :
yarn install # ou npm install -
Lancer le serveur de développement :
yarn start # ou npm start
Le site sera accessible à l'adresse http://localhost:3000. Toute modification des fichiers sources (dans docs/ ou src/) sera automatiquement rechargée.
Ce projet est distribué sous licence MIT. Voir le fichier LICENSE pour plus d'informations.
Un grand merci à tous les contributeurs qui font vivre cette documentation !