-
Notifications
You must be signed in to change notification settings - Fork 819
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
chore: checks links in typedoc html #2669
Conversation
Codecov Report
@@ Coverage Diff @@
## main #2669 +/- ##
=======================================
Coverage 92.53% 92.53%
=======================================
Files 144 144
Lines 5186 5186
Branches 1106 1106
=======================================
Hits 4799 4799
Misses 387 387 |
@@ -174,7 +172,7 @@ For a more detailed breakdown of feature support see the [specification complian | |||
We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and | |||
[good first issue][good-first-issues] to get started with the project. For | |||
instructions to build and make changes to this project, see the | |||
[CONTRIBUTING](CONTRIBUTING.md) guide. | |||
[CONTRIBUTING][CONTRIBUTING] guide. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Markdown link is not accessible in typedoc generated sites.
@@ -33,8 +33,6 @@ | |||
• | |||
<a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/development-guide.md">Development Guide</a> | |||
• | |||
<a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/benchmark/README.md">Benchmarks</a> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Benchmarks have been removed in #2462.
02557fc
to
0a468f3
Compare
0a468f3
to
f52d89a
Compare
No idea why the |
f32f6c1
to
0e70083
Compare
This PR is ready for review. There are chances that typedoc will fail on the CI for OOM, though I didn't constantly reproduce the problem locally. So increasing the memory limit for now. |
Which problem is this PR solving?
#2657 only checks on markdown files (and doesn't interpret HTML in markdown files). Adopt the tool linkinator that already used in opentelemetry-js-api.
Type of change
Checklist: