Generated documentation in docs folder contain paths to contributors' forks

[rikoe]

The README.md asks contributors to run yarn run doc after making changes, but this produces URI links ("Defined In") to their own forks.

This means that:

• These files change for every PR by a different contributor, polluting code diffs.
• These paths to forks get merged into the upstream repo still containing links to the fork, thereby making them incorrect.

These URI paths should either be relative, or always point to the upstream repo. If this is not possible, they should not be included at all, or generated documentation should not be checked in to the repo.

Example:
*Defined in [interface.ts:41](https://github.com/ColinEberhardt/API/blob/eac0696/src/interface.ts#L41)*

[nkolba]

added a temp fix with #33

Agree that generated docs should probably not be in git repo long term

[rikoe]

@nkolba Changing the URLs themselves aren't good enough, you need to change the typedoc process, otherwise it is a problem for every PR. Please see my PR #32.

[nkolba]

Agreed, saw your PR after. Let’s apply (though, the generated files are now in conflict- can you fix or remove them from the PR).

…

Sent from my iPhone

On Sep 24, 2018, at 6:04 AM, Riko Eksteen ***@***.***> wrote: @nkolba Changing the URLs themselves aren't good enough, you need to change the typedoc process, otherwise it is a problem for every PR. Please see my PR #32. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.