Skip to content

chore(docs): fix console warnings, codesandbox builds#86

Merged
dlabaj merged 1 commit intomainfrom
chore/11-docs-warnings
Nov 25, 2024
Merged

chore(docs): fix console warnings, codesandbox builds#86
dlabaj merged 1 commit intomainfrom
chore/11-docs-warnings

Conversation

@evwilkin
Copy link
Copy Markdown
Member

@evwilkin evwilkin commented Nov 21, 2024

Closes #11

This PR:

  • Updates example exports to be named exports to avoid console warnings (export const Example... vs. const Example .... export default Example)
    • These errors are thrown by our code in mdx-ast-to-mdx-hast.js which throws an error when the name of an exported example cannot be easily parsed.
    • See codesandbox.js for the supported example export naming conventions.
  • Fixes Codesandbox builds for examples as the default example exports were breaking those examples - named exports fixes this.
  • Updates the relative import of the realTestData.js file across examples to an absolute import path to fix an issue of the relative import breaking the Codesandbox examples.

Copy link
Copy Markdown
Contributor

@nicolethoen nicolethoen left a comment

Choose a reason for hiding this comment

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

Ran it locally and it all looks good! :)

@dlabaj dlabaj merged commit fdcecca into main Nov 25, 2024
@github-actions
Copy link
Copy Markdown

github-actions bot commented Dec 4, 2024

🎉 This PR is included in version 6.1.0-prerelease.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@nicolethoen nicolethoen deleted the chore/11-docs-warnings branch August 5, 2025 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug - examples in docs causing build:docs warnings

3 participants