crawlee
crawlee copied to clipboard
Make references in code documentation clickable inside IDE
Which package is the feature request for? If unsure which one to select, leave blank
@crawlee/core
Feature
IDEs are able to show code documentation, but if the documentation references another object / part of the API, the IDE is not able to recognize it and generate a clickable link.
This is because IDEs are not able to recognize @apilink
, which is specific for the typedoc pluging we use.
Motivation
Better developer experience.
Ideal solution or implementation, and any additional constraints
We could replace @apilink
with @link
during build.
Alternative solutions or implementations
No response
Other context
Reported internally on Slack.