fix(docs): repair generated API documentation so that links between packages are rendered #567
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #566
Proposed Changes
api-extractor
output are validated against existing identifiers,fix-extracted-api-files.js
was modified!~
to simple!
is sufficient to make things work, for exampleFIXED @influxdata/influxdb-client!~WriteRetryOptions:interface => @influxdata/influxdb-client!WriteRetryOptions:interface
api-extractor
and a list of id prefixes that are ignored (with a documented explanation)1
exit codeyarn apidoc:ci
will fail and therefore CI checks will fail on invalid referencesMoreover, this PR also upgrades
api-extractor
andapi-documenter
to latest version. Some of the issues get resolved with the upgrade.Checklist
yarn test
completes successfully