moscajs/mosca

Write documentation in plain markdown

Ouverte

#501 ouverte le 18 juin 2016

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)JavaScript (498 forks)github user discovery
help wanted

Métriques du dépôt

Stars
 (3 186 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Currently the documentation is written inlined in the code, using a (now-broken) documentation generation system.

We should rewrite this into a doc folder just using "plain" markdown.

Guide contributeur

Direction de recherche
Examinez la documentation en ligne existante dans le code source, puis créez un nouveau dossier 'doc' avec des fichiers Markdown simples qui reproduisent le contenu de manière structurée.
Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90