Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make references in code documentation clickable inside IDE #2717

Open
tobice opened this issue Oct 16, 2024 · 0 comments
Open

Make references in code documentation clickable inside IDE #2717

tobice opened this issue Oct 16, 2024 · 0 comments
Assignees
Labels
feature Issues that represent new features or improvements to existing features. t-tooling Issues with this label are in the ownership of the tooling team.

Comments

@tobice
Copy link

tobice commented Oct 16, 2024

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.

image

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.

@tobice tobice added the feature Issues that represent new features or improvements to existing features. label Oct 16, 2024
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Oct 16, 2024
@B4nan B4nan self-assigned this Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Issues that represent new features or improvements to existing features. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Development

No branches or pull requests

2 participants