Skip to content
This repository has been archived by the owner on Jul 24, 2020. It is now read-only.

La page github.io n'est pas à jour / pas claire #380

Open
BastienDuplessier opened this issue May 8, 2018 · 2 comments
Open

La page github.io n'est pas à jour / pas claire #380

BastienDuplessier opened this issue May 8, 2018 · 2 comments
Assignees
Labels
Documentation Issue regarding the documentation (misleading description, typo., bad translation...). 🇫🇷 French issue Transversal Issue which concerns the whole project (implementation / integration / documentation / license...).

Comments

@BastienDuplessier
Copy link
Collaborator

On nous fait remarquer sur http://rmex.github.io/ ;

  • On voit toujours RMEBuilder : il est déprécié
  • Pas d'indication sur comment installer le script
  • Wiki github incomplet

Il faudrait que l'on décide que faire.

@BastienDuplessier BastienDuplessier added the Documentation Issue regarding the documentation (misleading description, typo., bad translation...). label May 8, 2018
@gr-im
Copy link
Contributor

gr-im commented May 9, 2018

Pour la page d'accueil, je suis plutôt d'accord.
Par contre, je trouve que le wiki est relativement complet. Que proposes-tu ?

@acs-l
Copy link
Contributor

acs-l commented May 9, 2018

Je pense qu'on pourrait sensiblement l'améliorer en :

  • refaisant une passe dessus pour le réactualiser (la dernière mise-à-jour des pages date d'il y a plus de trois ans 😞)
  • le liant avec la documentation des commandes
  • recatégorisant les sections
    • une section intégration indiquant comment installer le RMEx/RME (pour un utilisateur / pour un développeur)
    • une section utilisation (qui concentre une grosse partie du wiki actuel)
    • une section développement (pour aider les contributeurs à localiser et comprendre les mécanismes implémentés dans RMEx/RME; je pense plus particulièrement à : "Comment ajouter une commande ?", "Comment modifier la documentation d'une commande (correction d'une coquille, reformulation pour plus de clarté, ajout d'une nouvelle langue...) ?", "Comment créer un script qui exploite / s'interface avec les commandes RMEx/RME?"...
  • ajoutant des exemples (mais ça revient à RMEx/tutorials)

Bon, ça c'était sur le fond; mais sur la forme, il me semble qu'il y a aussi moyen de rendre le wiki plus sexy et facile d'utilisation en s'inspirant de ce que FoxFiesta fait actuellement : rpgmakeralliance/wiki 😄.

@acs-l acs-l added this to the (2.0.0) Refactoring commands & new documentation milestone Aug 25, 2018
@acs-l acs-l self-assigned this Aug 25, 2018
@acs-l acs-l added 🇫🇷 French issue Transversal Issue which concerns the whole project (implementation / integration / documentation / license...). labels Aug 25, 2018
@xvw xvw removed this from the (2.0.0) Refactoring commands & new documentation milestone Oct 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation Issue regarding the documentation (misleading description, typo., bad translation...). 🇫🇷 French issue Transversal Issue which concerns the whole project (implementation / integration / documentation / license...).
Projects
None yet
Development

No branches or pull requests

4 participants