tsdjs/tsd

Improve documentation

Open

#55 创建于 2019年11月13日

在 GitHub 查看
 (12 评论) (0 反应) (0 负责人)TypeScript (2,551 star) (68 fork)user submission
help wantedquestion

描述

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?

贡献者指南

技术栈
typescriptnodejs
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
unclear
前置要求
Basic TypeScript knowledgeUnderstanding of tsd assertions
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
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.
Improve documentation · tsdjs/tsd#55 | Good First Issue