24-07-2019, 11:37 PM
En effet, markdown m'a l'air tout simple et la structure de page (l'attribut en titre de la section et sa description en contenu) m'ont plu.
Mais après coup, je me suis aperçu que markdown, c'est hyper-chiant à générer à cause des indentations: faire la doc à la mano, ça veut dire que dans 2 semaines, elle ne correspondra plus au code source. Du coup, j'ai préféré générer cette doc à partir des sources JS, pour être sûr qu'elle soit à jour (à considéré que je relance la génération quand je déploie!)
DU coup, j'ai gardé le concept de titre = attribut/classe et contenu = description de son effet, mais je l'ai généré en HTML (ça permet aussi de faire du kikoo pour la présentation : ) )
J'en ai profité pour intégrer l'open API du jeu (enfin, un truc qui s'en approche): en gros, la liste des URLs avec le verbe HTTP correspondant. Il faudra que j'ajoute la liste des paramètres, leur type/domaine et la description de la réponse (mais bon, faudrait aussi que j'ajoute la doc de chacun de ces endpoints... on verra bien).
Voilà donc le résultat: https://eclerd.com/resources/doc/doc.html
Ca fait le taff que je voulais (liste des classes/attributs avec l'effet pour peu que je le documente correctement). Pour le reste (styling & open API), c'est juste que je me suis laissé entraîné
Mais après coup, je me suis aperçu que markdown, c'est hyper-chiant à générer à cause des indentations: faire la doc à la mano, ça veut dire que dans 2 semaines, elle ne correspondra plus au code source. Du coup, j'ai préféré générer cette doc à partir des sources JS, pour être sûr qu'elle soit à jour (à considéré que je relance la génération quand je déploie!)
DU coup, j'ai gardé le concept de titre = attribut/classe et contenu = description de son effet, mais je l'ai généré en HTML (ça permet aussi de faire du kikoo pour la présentation : ) )
J'en ai profité pour intégrer l'open API du jeu (enfin, un truc qui s'en approche): en gros, la liste des URLs avec le verbe HTTP correspondant. Il faudra que j'ajoute la liste des paramètres, leur type/domaine et la description de la réponse (mais bon, faudrait aussi que j'ajoute la doc de chacun de ces endpoints... on verra bien).
Voilà donc le résultat: https://eclerd.com/resources/doc/doc.html
Ca fait le taff que je voulais (liste des classes/attributs avec l'effet pour peu que je le documente correctement). Pour le reste (styling & open API), c'est juste que je me suis laissé entraîné