Skip to content

docs(headless): enhance documentation for SSR state inference utilities #5764

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs(headless): enhance documentation for SSR state inference utilities #5764

wants to merge 3 commits into from
+11 −0

Conversation

vhilotii-coveo
Copy link
Contributor

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

  • Enhance JSDoc for defineCommerceEngine to reference InferStaticState and InferHydratedState utilities
  • Improves discoverability and guidance for inferring static and hydrated state types in SSR

[NON BREAKING]

  • This documentation update helps users leverage built-in SSR type inference more easily.

@vhilotii-coveo vhilotii-coveo requested a review from y-lakhdar July 28, 2025 15:37
@vhilotii-coveo vhilotii-coveo self-assigned this Jul 28, 2025
@developer-experience-bot
Copy link
Contributor

developer-experience-bot bot commented Jul 28, 2025 •
edited
Loading

Pull Request Report

PR Title

✅ Title follows the conventional commit spec.

Live demo links

Bundle Size

File Old (kb) New (kb) Change (%)
case-assist 253.3 253.3 0
commerce 365.9 365.9 0
search 425.6 425.6 0
insight 416.6 416.6 0
recommendation 264.2 264.2 0
ssr 419 419 0
ssr-commerce 383 383 0

@vhilotii-coveo vhilotii-coveo marked this pull request as ready for review July 30, 2025 13:49
@vhilotii-coveo vhilotii-coveo requested a review from a team as a code owner July 30, 2025 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fbeaudoincoveo fbeaudoincoveo fbeaudoincoveo approved these changes

@alexprudhomme alexprudhomme alexprudhomme approved these changes

@y-lakhdar y-lakhdar Awaiting requested review from y-lakhdar y-lakhdar was automatically assigned from coveo/dxui

@louis-bompart louis-bompart Awaiting requested review from louis-bompart louis-bompart was automatically assigned from coveo/dxui

Assignees

@vhilotii-coveo vhilotii-coveo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@vhilotii-coveo @y-lakhdar @fbeaudoincoveo @alexprudhomme