TODO documentation

[njourdane]

Ce ticket permet de noter les petits détails à corriger dans la documentation de Zest Writer (URLs à corriger, faute de frappe, etc). Le but est de faire ces différentes modifications en un seul commit (ou plusieurs commit et une seule PR), histoire de limiter le nombre de commits, le nombre de PR, le nombre de ticket, etc.

Ce ticket ne sera pas fermé et mis à jour régulièrement.

Je me chargerais d'intégrer les modifications notées ici. Les grosses modifications, qui nécessitent notamment de tester le comportement sur readthedocs (par exemple si on ajoute une extension Sphinx) passeront par ma version de la doc (générée depuis roipoussiere/doc), puis PR vers firm1/master.

Cela ne vous empêche pas bien sur de modifier des fichiers .rst lors de vos commits !

---

• renommer la page Documentation en Documenter (plus clair) ;
• lien vers la page de la Javadoc devrait renvoyer vers cette page ;
• mettre en place la liste des todo se basant sur les tags Javadoc @todo ;
• ajouter un template pour les tickets ;
• ajouter un fichier contributing ;

[firm1]

J'ai fais une mise à jour de la doc. Je me demande si tu n'aurai pas oublié d'activer un hook quelque part qui update la doc directement en ligne.

[njourdane]

Ah ?

Bon je suis en 3G jusqu'à mardi soir là mais je regarderais. Peut-être que j'ai oublié un truc lors de la transition de la doc vers ton dépôt.