danger / danger-js

⚠️ Stop saying "you forgot to …" in code review
http://danger.systems/js/
MIT License
5.25k stars 367 forks source link

[BUG] Some links in reference docs are broken #1074

Open goodspark opened 3 years ago

goodspark commented 3 years ago

Describe the bug

Some links in the reference docs lead to nothing.

To Reproduce Steps to reproduce the behavior:

  1. Go to https://danger.systems/js/reference.html#GitDSL
  2. Click on the link for 'Chainsmoker'
  3. Nothing happens

Expected behavior

I think Chainsmoker is an external type. So folding it into the reference docs may not be tenable (thinking about having to do that for all external types). So maybe those links should point to the package they came from? ie. https://github.com/paulmelnikow/chainsmoker#usage

Additional context

From my quick checks, the following also have this problem:

These appear to be internal types. So maybe the generated docs are broken or out of date?

orta commented 3 years ago

Chainsmoker is the only external type to my knowledge, so this could be handled as an edge case in the web renderer 👍🏻