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-react): create typedoc site & publish it as an artifact #4747

Merged
merged 16 commits into from
Dec 28, 2024

Conversation

alexprudhomme
Copy link
Contributor

@alexprudhomme alexprudhomme commented Nov 29, 2024

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

This PR adds a typedoc site for headless-react, here it is below

docs.zip

This PR also includes small improvements to the current typedoc setup of headless.

Copy link

github-actions bot commented Nov 29, 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 242.9 242.9 0
commerce 354 354 0
search 414 414 0
insight 405.2 405.2 0
recommendation 255.1 255.1 0
ssr 407.4 407.4 0
ssr-commerce 371.3 371.3 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

@alexprudhomme alexprudhomme changed the title docs(headless-react: create typedoc site & publish it as an artifact docs(headless-react): create typedoc site & publish it as an artifact Nov 29, 2024
Base automatically changed from KIT-3423 to master December 2, 2024 17:16
@alexprudhomme alexprudhomme marked this pull request as ready for review December 17, 2024 13:23
@alexprudhomme alexprudhomme requested review from a team as code owners December 17, 2024 13:23
@alexprudhomme alexprudhomme marked this pull request as draft December 17, 2024 13:24
@alexprudhomme alexprudhomme marked this pull request as ready for review December 17, 2024 13:44
Copy link
Contributor

@jpmarceau jpmarceau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice Alex, this is going to be very helpful for users.

packages/headless-react/typedoc/documents/hooks.md Outdated Show resolved Hide resolved
packages/headless-react/typedoc/documents/hooks.md Outdated Show resolved Hide resolved
packages/headless-react/typedoc/documents/hooks.md Outdated Show resolved Hide resolved
packages/headless-react/typedoc/documents/hooks.md Outdated Show resolved Hide resolved
packages/headless-react/typedoc/documents/hooks.md Outdated Show resolved Hide resolved
packages/headless-react/typedoc/documents/hooks.md Outdated Show resolved Hide resolved
packages/headless-react/typedoc/documents/hooks.md Outdated Show resolved Hide resolved
packages/headless-react/typedoc/lib/index.tsx Show resolved Hide resolved
alexprudhomme and others added 2 commits December 19, 2024 08:33
Co-authored-by: jpmarceau <39384459+jpmarceau@users.noreply.github.com>
Co-authored-by: jpmarceau <39384459+jpmarceau@users.noreply.github.com>
Copy link
Contributor

@fbeaudoincoveo fbeaudoincoveo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job!

@alexprudhomme alexprudhomme added this pull request to the merge queue Dec 27, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 27, 2024
@alexprudhomme alexprudhomme added this pull request to the merge queue Dec 28, 2024
Merged via the queue into master with commit 3f2b6fa Dec 28, 2024
124 checks passed
@alexprudhomme alexprudhomme deleted the KIT-3698 branch December 28, 2024 00:41
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.

3 participants