Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ajout du Wiki #104

Draft
wants to merge 77 commits into
base: dev
Choose a base branch
from
Draft

Ajout du Wiki #104

wants to merge 77 commits into from

Conversation

CORAAL
Copy link
Contributor

@CORAAL CORAAL commented Dec 26, 2024

Ce pull-request vise à intégrer au dépôt un wiki hébergé via github pages.

Le Wiki est fonctionnel et est prêt à être utilisé en l'état, je souhaite achever quelques pages supplémentaires pour fournir un point de départ sérieux (ex: Expliquer comment écrire la documentation).

Vous pouvez consulter le wiki ici (temporaire).

Ce qu'il faut savoir :

  • Ce PR inclut l'ajout d'un workflow qui s'occupe de générer le site statique contenant la documentation.
  • La documentation est générée systématiquement et automatiquement, lorsque le répertoire docs est modifié.
  • Il faut environ une minute pour générer la documentation.
  • La documentation est écrite en markdown.
  • Il est possible d'ajouter des layouts particuliers pour modifier l'apparence des pages.
  • Support des "callouts" (légende) pour mettre en avant certaines informations.
    • Notez que les callouts ne sont pas propres au markdown (plus d'info ici)
  • Le flocon intègre un "devShell" pour permettre le test de la documentation en direct.
    • Le devshell est prévu pour fonctionner peu importe l'architecture du développeur, pour ce faire, j'ai du ajouter "flake-utils" dans les inputs.

À faire avant la fusion

  • Modifier la branche surveillée de wiki_initdev ici
  • Corriger les fautes d'orthographe, conjugaison et grammaire.
  • Ajouter à flake.nix un Shell de développement (nix develop) pour permettre de construire localement la documentation (dans le but de la vérifier avant soumission)

À faire après la fusion

  •  Activer le workflow fusionné depuis la page action.

Note

N'hésitez pas à faire vos retours si vous avez des commentaires :)

@CORAAL CORAAL added the documentation Improvements or additions to documentation label Dec 26, 2024
@CORAAL CORAAL added this to the Next Release milestone Dec 26, 2024
@CORAAL CORAAL linked an issue Dec 26, 2024 that may be closed by this pull request
@darkone-linux
Copy link
Member

Tu es à fond 💯

@DavidBrigand
Copy link

Super mais pour la commande mettre à jour manuellement le module GLF
sudo bash /etc/update-glf-config.sh
à la place de
bash /etc/update-glf-config.sh ?

@CORAAL
Copy link
Contributor Author

CORAAL commented Dec 31, 2024

Super mais pour la commande mettre à jour manuellement le module GLF sudo bash /etc/update-glf-config.sh à la place de bash /etc/update-glf-config.sh ?

Bonne remarque, merci beaucoup, c'est corrigé

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Road to Alpha
Development

Successfully merging this pull request may close these issues.

Documentation - F.A.Q
3 participants