Pourquoi cette doc ?

Une petite introduction concernant les guides & informations que vous trouverez sur cet espace de documentation.

Le constat de départ est assez simple : j'ai une mémoire de poisson rouge. De ce fait, dès lors que j'ai commencé à travailler sur plusieurs projets en parallèle et que j'ai commencé à avoir besoin de maintenir, reprendre & reproduire certaines choses, documenter mes projets m'est apparu comme nécessaire pour gagner du temps et éviter la sensation de frustration de devoir à nouveau recommencer quelque chose de connu.

Initialement, j'avais donc pour habitude de stocker ma documentation sous forme de fichiers textes plus ou moins clairs et propres. Dans le but d'avoir un backup permanent de tout cela, je me suis rapidement tourné vers GitHub pour versionner ces documents (sachant qu'ils ne contiennent aucune donnée sensible). J'écrivais donc ma documentation principalement au format Markdown, aidé via l'excellent StackEdit que je ne peux que vous recommander et que j'utilise encore à ce jour dans certains cas particuliers.

Une fois la documentation présente sur GitHub, je me suis rendu compte qu'en l'étoffant et en la peaufinant un peu, je pourrais en faire quelque chose d'utilisable (pas nécessairement utile) pour les autres. J'ai donc pris le temps d'ajouter dans mes documentations certains éléments de détails qui ne m'étaient pas forcément nécessaires mais qui, pour sûr, serviraient à d'autres. Nous voilà donc rendu avec un répertoire de documentation au format Markdown publiquement accessible sur GitHub.

À partir de ce point, la transition vers la documentation que vous consultez actuellement se fît simplement. Après avoir consommé beaucoup de contenu sur GitBook ces derniers temps, j'ai jugé cette alternative vraiment adaptée à mon besoin et GitBook me semblait être l'outil idéal pour donner un accès clair et efficace à ma documentation. De plus, la "migration" depuis GitHub est simplissime. Je dis "migration" entre guillemets car en réalité, GitBook et GitHub sont synchronisés. Le second servant de base de versionning au premier.

Je vous souhaite donc une très bonne lecture et espère être utile à certains d'entre vous !