docs(atomic): Migrating atomic-did-you-mean doc to storybook

[eguyon-coveo]

Jira ticket

[Copilot]

Pull request overview

This PR migrates the documentation for the atomic-did-you-mean component to Storybook by creating a new .mdx file that integrates with the existing Storybook stories.

Key Changes:

• Creates a Storybook documentation file following the AtomicDocTemplate pattern
• Adds usage examples and best practices for the component
• Includes external reference links for additional context

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The closing tag </atomic-commerce-did-you-mean> doesn't match the opening tag <atomic-did-you-mean>. The closing tag should be </atomic-did-you-mean> to match the opening tag.

Suggested change

	<atomic-did-you-mean></atomic-commerce-did-you-mean>
	<atomic-did-you-mean></atomic-did-you-mean>

[Copilot]

The githubPath points to a .ts file (atomic-did-you-mean.ts), but the actual component file is atomic-did-you-mean.tsx. This should be updated to "search/atomic-did-you-mean/atomic-did-you-mean.tsx" to point to the correct file.

Suggested change

	githubPath="search/atomic-did-you-mean/atomic-did-you-mean.ts"
	githubPath="search/atomic-did-you-mean/atomic-did-you-mean.tsx"

[alexprudhomme]

You can leave it as .ts for now as we will do the migration very soon.

[Copilot]

This sentence is incomplete and grammatically incorrect. It should read: "* When the current query returns results, but the index has more frequently occurring terms with similar spelling, the component presents a link containing the new terms."

Suggested change

	* The current query returns results, but the index has more frequently occurring terms with similar spelling, the component presents a link containing the new terms.
	* When the current query returns results, but the index has more frequently occurring terms with similar spelling, the component presents a link containing the new terms.

[Copilot]

This sentence fragment is incomplete. It should be part of the previous bullet point or rephrased as a complete sentence. Consider: "* A soft nudge asking users if that's what they meant can direct them to the most relevant results."

Suggested change

	* The current query returns results, but the index has more frequently occurring terms with similar spelling, the component presents a link containing the new terms.
	When clicked, the link triggers a new query using the corrected keywords.
	* A soft nudge asking them if that's what they meant can direct them to the most relevant results.
	* The current query returns results, but the index has more frequently occurring terms with similar spelling. The component presents a link containing the new terms, and a soft nudge asking users if that's what they meant can direct them to the most relevant results. When clicked, the link triggers a new query using the corrected keywords.

[jpmarceau]

Also, I'm curious: why not include this info from the original article?

[alexprudhomme]

👍 just the copilot comment

[alexprudhomme]

You can leave it as .ts for now as we will do the migration very soon.