docs(headless-react): more typedoc annotations #4890
Merged
Conversation
This file contains 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
Pull Request ReportPR Title✅ Title follows the conventional commit spec. Live demo linksBundle Size
SSR Progress
Detailed logssearch : buildInteractiveResultsearch : buildInteractiveInstantResult search : buildInteractiveRecentResult search : buildInteractiveCitation search : buildGeneratedAnswer recommendation : missing SSR support case-assist : missing SSR support insight : missing SSR support commerce : missing SSR support |
jpmarceau
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
jpmarceau
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
jpmarceau
requested review from
olamothe,
fpbrault,
y-lakhdar and
fbeaudoincoveo
jpmarceau
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
jpmarceau
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
alexprudhomme
approved these changes
Jan 24, 2025
jpmarceau
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
fbeaudoincoveo
approved these changes
Jan 24, 2025
Co-authored-by: Frederic Beaudoin <fbeaudoin@coveo.com>
jpmarceau
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
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.
https://coveord.atlassian.net/browse/LENS-2449
A number of updates meant to improve the generated typedoc documentation for the headless-react package.
I've added links to docs.coveo.com in a few places, but it's expected that they won't work until I merge https://github.com/coveo/doc_jekyll-public-site/pull/12443 (probably early next week)
Live demo: https://docs.coveo.com/en/headless-react/latest/reference
Notably:
https://docs.coveo.com/en/headless-react/latest/reference/functions/SSR_Commerce.index.defineCommerceEngine.html
https://docs.coveo.com/en/headless-react/latest/reference/functions/SSR_Commerce.index.buildProviderWithDefinition.html
https://docs.coveo.com/en/headless-react/latest/reference/types/SSR_Commerce.index.ProductList.html
https://docs.coveo.com/en/headless-react/latest/reference/types/SSR_Commerce.index.SearchBox.html