docs(headless-react): address broken typedoc links #5123
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jsmith2-coveo
requested review from
olamothe,
fpbrault,
y-lakhdar,
fbeaudoincoveo and
jpmarceau
jsmith2-coveo
had a problem deploying
to
PR Artifacts
GitHub Actions
Failure
Pull Request ReportPR Title✅ Title follows the conventional commit spec. Live demo linksBundle Size
|
jsmith2-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
DOC-16854
Certain links in the TypeDoc site were showing up in a duplicated format:
i.e.
https://docs.coveo.com/en/headless-react/latest/reference/functions/docs.coveo.com/en/obif0156#define-the-commerce-engine-and-controllers
When they should have been in the format:
https://docs.coveo.com/en/obif0156#define-the-commerce-engine-and-controllers
The comments these links were pulled from were missing the scheme, "https://", and thus showing up in the above formatting. Upon adding the missing scheme to the links, they functioned again as expected.