tsdjs/tsd

Improve documentation

Open

#55 ouverte le 13 nov. 2019

Voir sur GitHub
 (12 commentaires) (0 réactions) (0 assignés)TypeScript (2 551 stars) (68 forks)user submission
help wantedquestion

Description

I think we need to improve the documentation a bit. But I'm not sure how to provide the right amount of information.

So any ideas here are more than welcome. Like, should we add more examples? Should we add an example per assertion to make it more clear? Is the description good enough?

Guide contributeur

Stack technique
typescriptnodejs
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
unclear
Prérequis
Basic TypeScript knowledgeUnderstanding of tsd assertions
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
The issue is open ended, seeking ideas for improving documentation. Review the 12 comments for suggestions. Look at the current README and docs folder (likely in the repository root). Consider adding examples for each assertion type as mentioned in the issue body. Engage with maintainers to clarify scope and expectations.