Documentation au fil de l'eau ?

Si mes souvenirs sont bons, @tofulm avait testé un truc pour ça.

Hum pas sur que ce soit complètement automatique. L’idée serait de rajouter un contrôle qui permet de savoir si un plugin a une documentation sur Contrib et si non, si il a un readme de proposer una action pour créer la rubrique du plugin dans la bonne catégorie et avec l’article proincipal qui pointe sur le readme via Show Readme.

C’est pas trop brutal car on a la main dessus.

Pour ce point, comme il a déjà été abordé, il faudrait que le contenu du readme soit transposé dans SPIP (quitte à avoir le plugin Markdown en mode « pas par défaut » et à entourer le contenu venant du readme par les balises <markdown>) car sinon aucun contenu n’est indexé et l’article ne sortira pour à peu près aucune recherche. Mais ça veut dire garder en mémoire la source et régulièrement aller récupérer le contenu distant qui peut avoir changé entre temps (mais ça pourrait ne se faire que si ya un nouveau tag, nouvelle version qui est détectée).

Oui ou alors on a un cache avec expiration et un bouton actualiser sur la page au cas où.

Puisqu’il est question d’obsidienne, pouf je dirais que j’aime bien LogSeq https://logseq.com/

Bonne année à tous au fait :champagne: :bomb: :champagne:

Ce n’était pas du tout mon propos initial.
Je ne parlais pas de nouveaux outils, je proposais juste d’utiliser un dépôt git pour y stocker temporairement des morceaux de documentation, en vue d’une utilisation collective.

Mais c’était visiblement une mauvaise idée, vu l’enthousiasme que vous avez tous mis à dire que « ça ne marchera pas ».

Pas grave, j’ai d’autres sujets d’intérêt.

Ca dépend de quoi on parle. Le fait de documenter ce sujet et d’utiliser une organisation type diataxis, de travailler au début les objectifs et la table des matières non.
La question est pourquoi le faire en dehors de nos lieux actuels. Tu sais, quand tu administres un site comme Contrib tu aimes à penser qu’on peut toujours l’améliorer et en faire ce qu’il devrait un réceptacle de notre documentation. D’ailleurs on a toujours pas fait le pas de combiner Contrib et Plugins et je pense que c’est une meilleure démarche que de disperser.

Voui le sujet principal du fil « comment on s’organise pour documenter au fil de l’eau ? » est toujours parfaitement pertinent @nicod ! Donc c’est toujours utile de continuer à trouver un solution pour ça.

À la fin ça peut être un truc que tu avais en tête au début… ou autre chose, ça dépend de l’ensemble des idées proposées. Mais la question est toujours à résoudre oui.

Sinon encore une fois : sisi utiliser un dépôt git c’est considéré comme « un nouvel outil » à partir du moment où ce n’était pas pas utiliser pour ça à la base. Ce n’est pas parce que l’outil (la forge) est déjà en place, qu’on l’utilise pour ce besoin, donc se mettre à l’utiliser pour ça est bien un nouvel outil ou nouveau lieu si tu préfères en plus de ce qui est déjà en place (= les lieux finaux spip.net + programmer pour le core + contrib pour les plugins + le wiki de contrib pour le bazar + les tickets déjà existants dans chaque dépôt).

D’ailleurs ça me fait penser qu’il y a aussi d’ors et déjà des tickets tagués « documentation », indiquant 1) un sujet sur lequel on sait qu’il manque de la documentation, et 2) souvent dans le ticket ou ses commentaires ou les commits de la PR qui a résolu le ticket, des bribes de ce qu’il y a à documenter pour ce sujet. C’est donc déjà aussi un lieu-outil déjà utilisé, en plus du wiki de Contrib (et qui est bien plus facile à trier par statut fait/pas fait que le wiki pour suivre ce qu’il reste à faire).

J’ai complètement lâché le fil.
Qu’est ce qui manque pour avancer ? (à part du temps et de la motivation, mais je peux en trouver un peu).

Ça sort de ce que je proposais ici, c’est même l’inverse, mais c’est un chantier qui me parait intéressant.
Et en fait, à partir d’une (ou plusieurs, par public) tables des matières (sous forme d’arborescences de dossiers par exemple) on pourrait justement coller ces bouts de docs temporaires aux endroits idoines en mode WIP.

Tu crées un nouveau fil pour en discuter ?

Oui moi aussi car je suis à un moment où j’ai besoin d’aide pour composer les page d’un point de vue HTML/CSS.
Avec @maieul et @rastapopoulos on a rédigé une description sommaire des pages qu’il conviendrait surement d’affiner et de prototyper.

Ben en fait c’est complémentaire ou plutôt préalable. Pour que ta proposition fonctionne au mieux je pense qu’il est préférable de définir l’objectif et de guider les contributeurs. On ira plus vite à l’objectif et on aura aussi l’impression que ça avance plus car tout ne sera pas forcément à reprendre dans un espoir parfois vain.
Ok, on peut créer un nouveau fil.

Tu peux repointer l’endroit où vous avez rédigé ça ?

Je te laisse faire ?