Skip to content
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

docs(headless): cover a few missing types for reference documentation #4679

Merged
merged 5 commits into from
Nov 18, 2024

Conversation

jpmarceau
Copy link
Contributor

https://coveord.atlassian.net/browse/KIT-3727

While working on generating typedoc documentation, I noticed some missing types and example links.
For instance, before (GeneratedFacetControllers type not exported):
Screenshot 2024-11-14 at 2 10 12 PM

After (GeneratedFacetControllers type exported and documented):
Screenshot 2024-11-14 at 2 09 36 PM
Screenshot 2024-11-14 at 2 11 26 PM

@jpmarceau jpmarceau requested a review from a team as a code owner November 14, 2024 19:13
Copy link

github-actions bot commented Nov 14, 2024

Pull Request Report

PR Title

✅ Title follows the conventional commit spec.

Live demo links

Bundle Size

File Old (kb) New (kb) Change (%)
case-assist 236.8 236.8 0
commerce 341.5 341.5 0
search 412.8 412.8 0
insight 402.1 402.1 0
recommendation 249.1 249.1 0
ssr 406.3 406.3 0
ssr-commerce 353.7 353.7 0

SSR Progress

Use case SSR (#) CSR (#) Progress (%)
search 39 44 89
recommendation 0 4 0
case-assist 0 6 0
insight 0 27 0
commerce 0 15 0
Detailed logs search : buildInteractiveResult
search : 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 jpmarceau changed the title headless(docs): cover a few missing types for reference documentation docs(headless): cover a few missing types for reference documentation Nov 15, 2024
@jpmarceau jpmarceau added this pull request to the merge queue Nov 18, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 18, 2024
@jpmarceau jpmarceau enabled auto-merge November 18, 2024 18:20
@jpmarceau jpmarceau added this pull request to the merge queue Nov 18, 2024
Merged via the queue into master with commit 5de23b7 Nov 18, 2024
121 checks passed
@jpmarceau jpmarceau deleted the KIT-3727 branch November 18, 2024 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants