A quand une doc'
saturnin Membre non connecté
Booster Minigun
- Booster Minigun
- Voir le profil du membre saturnin
- Inscrit le : 15/04/2013
- Groupes :
Reprise du message précédent
voilà,ElenWii tu voulait savoir ce qui ne vas pas dans la doc ? regarde la réponse ou réaction de xela.
en prime il est rédacteur, ce qui laisse rêveur tant a sa réaction.
L'article date de la V4 - v5 un des plus gros chantier.
Si la réponse des rédacteurs au problème de doc est : "allez vous former au php" c'est sur que c'est loin d’être gagné.
Bon courage ...
xela Membre non connecté
- Modérateur
- Voir le profil du membre xela
- Inscrit le : 26/12/2015
- Groupes :
- Equipe Rédaction
De plus, critiquer sans savoir ce que je fais est de loin petit.
Si vous voulez avoir des conseils sur comment faire un module, ce n'est pas comme ça qu'il faut s'y prendre.
Dossier fermé en ce qui me concerne.
Cordialement,
Xela.
Édité par xela Le 15/11/2017 à 15h46
janus57 Membre non connecté
- Booster Fusée
- Voir le profil du membre janus57
- Inscrit le : 07/12/2007
- Groupes :
- Equipe Assistance
comme dit plus haut une MàJ de la doc API (en V5.1 donc) est en cours pour être intégré ici + la version SDK.
Mais elle ne sera pas complète à cause du manque de commentaires dans le kernel qui a été hérité des anciennes versions et où personne ne s'est jamais vraiment penché dessus pour les mettre en place (car cela demande du temps, beaucoup de temps et faire de la doc 24/7 ce n’est pas le top non plus).
Pour la doc présente dans le wiki cela présente la base de la création de modules, comme la structure, les fichiers importants et les fichiers nécessaires absolument, le reste étant dans la doc API (rappel : mise à jour en cours).
Si dans le wiki il y a besoin d'une doc sur quelque chose de précis il faut à ce moment le signaler en précisant le point qui doit être détaillé, sans oublier qu'il est possible de prendre exemple sur les modules existant pour voir comment cela est mis en pratique (on peut voir cela comme un exemple présent sur la doc PHP).
Cordialement, janus57
ElenWii Membre non connecté
- Administrateur
- Voir le profil du membre ElenWii
- Inscrit le : 14/08/2009
- Site internet
- Groupes :
- Equipe Graphique
Comme le dit Janus, ne confondons pas la documentation du wiki et la documentation dev.
la documentation wiki :
Objectif => permettre d'apprendre le fonctionnement de base de PHPBoost.
Par qui ?=> Elle est complétée au fur et à mesure des demandes soit par l'équipe PHPBoost soit par la communauté (wiki).
Travail en cours => Nous allons ajuster l'organisation pour simplifier sa lecture et identifier les sujets qui nous semblent manquer
La documentation dev :
Objectif => permettra à des développeurs de trouver les fonctions du noyau utilisables dans un module par exemple avec une explication de leurs fonctionnements. Cette documentation passe par la création de commentaires structurés dans les fichiers php.
Par qui ? => Elle est complétée au fur et à mesure des nouveaux développements par l'équipe de développement.
Travail en cours => Remettre à jour avec le code de la version 5.1 et rattraper le retard des versions précédentes
Le projet étant open-source avec une équipe de bénévole, nous sommes bien sûr ouvert à toute l'aide possible pour structurer et rédiger une documentation wiki (via le wiki) et compléter la documentation dev (via github)
Répondre
Sujet verrouillé, vous ne pouvez pas poster de message