tsdjs/tsd

Improve documentation

Open

#55 opened on Nov 13, 2019

View on GitHub
 (12 comments) (0 reactions) (0 assignees)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?

Contributor guide

Tech stack
typescriptnodejs
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
Basic TypeScript knowledgeUnderstanding of tsd assertions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.