Un site (https://pixel-circus.github.io/documentation/) est autogénéré grâce à cette configuration du repo GitHub: Easy Markdown to GitHub Pages.
La documentation est écrite avec la syntaxe Markdown.
- Éviter de créer une hiérarchie de dossiers, favoriser la création de document dans les dossiers existants.
- Le dossier "code" contient la documentation des langages et frameworks utilisés dans les projets.
- Le dossier "outils" contient la documentation de tous les logiciels/sites/technologies utilisés pour supporter le développement des projets.
- Le dossier "processus" contient toutes les étapes de réalisation de plusieurs types de tâches au sein de l'agence.
- Le dossier "projets" contient des aides mémoires qui contient les choses qui sont pas des évidnces ou qui sont des fa^cons de faire qui sont uniquement utilisées dans ce projet.
- Si une section est à compléter, la précéder d'un des deux préfixes suivants:
- TBD: To be decided Ce point nécessitera qu'on prenne une décision d'équipe sur cette question avant qu'on écrive la documentation.
- TODO: À faire Ce sujet a été discuté et décidé, mais il reste le texte a écrire.
- Naviguer vers le fichier à modifier et cliquer sur le crayon dans le coin à droite, ou créer un nouveau fichier en cliquant sur Add file
- Ajouter le contenu au fichier, ou le modifier
- Entrer les informations de commit dans le bas
- Pour une simple correction typographique, sélectionner "Commit directly", pour l'ajout de nouveau contenu, cliquer sur "Create a new branch ans start a pull request". Une pull request permettra à tout le monde de voir la mise à jour et d'apporter des commentaires et des correctifs le cas échéant
- Cloner le repo sur votre ordinateur et l'ouvrir dans Visual Studio Code
- Faire les modifications dans l'éditeur de code. L'extension "Markdown All in One" est recommandée pour faciliter l'édition et la prévisualisation du contenu.
- Commiter les changements sur une nouvelle branche.
TODO: déterminer la structure du nom de la branche - Créer la Pull Request avec l'extension Github Pull Requests.