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.