chore: fix cross project links and missing implicitly exported types

[legendecas]

Which problem is this PR solving?

Fixes docs:test failure in PRs like #3514 and #3517.

Short description of the changes

• Add plugin typedoc-plugin-missing-exports to generate docs for implicitly exported types.
• Add plugin typedoc-plugin-resolve-crossmodule-references to generate links between projects in the monorepo.

Type of change

• This change requires a documentation update

How Has This Been Tested?

Tested locally with NODE_OPTIONS=--max-old-space-size=6144 npm run docs and verified that the docs are generated as expected.

Checklist:

• Followed the style guidelines of this project
• Documentation has been updated

[codecov]

Codecov Report

Merging #3533 (b5743a6) into main (a42e4ed) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3533   +/-   ##
=======================================
  Coverage   93.80%   93.80%           
=======================================
  Files         249      249           
  Lines        7640     7640           
  Branches     1589     1589           
=======================================
  Hits         7167     7167           
  Misses        473      473           

[legendecas]

The Lint build would still fail since it checks with the published docs.

[pichlermarc]

Thank you for taking care of this 🙂

Should the MetricsAPI type be exported directly from the API package? Right now it looks like it is missing. 🤔

I ran the docs step locally and I think the file that's making the lint step fail will end up at
https://open-telemetry.github.io/opentelemetry-js/docs/classes/_opentelemetry_api._internal_.MetricsAPI.html instead of https://open-telemetry.github.io/opentelemetry-js/classes/_opentelemetry_api.MetricsAPI.html.

So the lint step may continue to fail. 🤔

[dyladan]

Doesn't this add internal details to our docs? Is that wanted? What is it fixing?

[pichlermarc]

I think the underlying problem may be that we're not exporting MetricsAPI from the API package - that makes the lint step fail as it is not part of the docs. 🤔

[dyladan]

Since this was never a problem with the other APIs, there is something being done differently then with metrics that needs to be fixed. I think this plugin is hiding a problem rather than fixing it.

[dyladan]

#3535

[legendecas]

Some types are not exported but rather their instances are, like in https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-resources/src/detectors/BrowserDetector.ts#L64. It is fine to use those values without their types exported. However, typedoc would explain these and would not document their types and link to their base classes.

[pichlermarc]

Looks good; thanks for the explanation in https://github.com/open-telemetry/opentelemetry-js/pull/3533/files#r1069636994 🙂