docs(atomic): default annotation name

[jpmarceau]

https://coveord.atlassian.net/browse/DOC-15584
documentation extraction supports @defaultValue, not @default. If you know a quick way to fix this twice (e.g., linter config to prevent this re-happening), let me know, I'd be happy to oblige.

[github-actions]

Pull Request Report

PR Title

✅ Title follows the conventional commit spec.

Live demo links

• Storybook

• Playwright report

Bundle Size

File	Old (kb)	New (kb)	Change (%)
case-assist	244.1	244.1	0
commerce	341.2	341.2	0
search	414.9	414.9	0
insight	392	392	0
product-listing	306.4	306.4	0
product-recommendation	214.9	214.9	0
recommendation	257.2	257.2	0
ssr	405.2	405.2	0
ssr-commerce	351	351	0

SSR Progress

Use case	SSR (#)	CSR (#)	Progress (%)
search	39	44	89
recommendation	0	4	0
product-recommendation	0	10	0
product-listing	0	13	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
product-recommendation : missing SSR support
product-listing : missing SSR support
case-assist : missing SSR support
insight : missing SSR support
commerce : missing SSR support

[alexprudhomme]

I can still find @default in these files. Is that intended ?

https://github.com/coveo/ui-kit/blob/DOC-15584/packages/headless/src/controllers/insight/quickview/headless-insight-quickview.ts#L55

https://github.com/coveo/ui-kit/blob/DOC-15584/packages/headless/src/controllers/core/quickview/headless-core-quickview.ts

[jpmarceau]

I can still find @default in these files. Is that intended ?

https://github.com/coveo/ui-kit/blob/DOC-15584/packages/headless/src/controllers/insight/quickview/headless-insight-quickview.ts#L55

https://github.com/coveo/ui-kit/blob/DOC-15584/packages/headless/src/controllers/core/quickview/headless-core-quickview.ts

Good question Alex.
Yes, the documentation process for Headless is completely different from the Atomic one. The issue I'm fixing here is only for Atomic, although the example you found are also broken in headless 😅
I wouldn't fix it now though, because I'm also working on implementing a new documentation generation mechanism for Headless, using Typedoc. Everything is going to change there.

[louis-bompart]

🤔 tho @default is the proper JSDOC tag, as @DefaultValue is for JavaDoc.

[jpmarceau]

🤔 tho @default is the proper JSDOC tag, as @DefaultValue is for JavaDoc.

Interesting, I wonder how we ended up supporting defaultValue.
At least it's the valid jsdoc synonym.

I'll close this and add support to the documentation generator instead :loading: