Skip to content

Conversation

@eguyon-coveo
Copy link
Contributor

@eguyon-coveo eguyon-coveo commented Nov 27, 2025

@eguyon-coveo eguyon-coveo changed the title docs(atomic): Migration atomic-did-you-mean doc to storybook docs(atomic): Migrating atomic-did-you-mean doc to storybook Nov 27, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment on lines 40 to 42
* 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.
Copy link

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Also, I'm curious: why not include this info from the original article?
Screenshot 2025-11-28 at 2 58 50 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch! I think I accidentally deleted it while refactoring the article

Copy link
Contributor

@alexprudhomme alexprudhomme left a comment

Choose a reason for hiding this comment

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

👍 just the copilot comment

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.

4 participants