pastelsky/tsdocs

Relative links in readme can be broken

Open

#9 opened on 2023年12月19日

GitHub で見る
 (12 comments) (2 reactions) (0 assignees)TypeScript (26 forks)github user discovery
good first issue

Repository metrics

Stars
 (1,124 stars)
PR merge metrics
 (PR metrics pending)

説明

From HN:

Consider showing files other than the README. Relative links to things like CONTRIBUTING.md currently break. Alternatively interpret all relative links as pointing to github.com or npmjs.com. It'd be great to have a way to link from the README into API docs to guide readers. The community doesn't have a great convention for this unfortunately.

コントリビューターガイド