diff --git a/README.md b/README.md index 50121cad..98c14433 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ You can insert Mermaid diagrams in markdown & MDX files to visualize Git commits ### Adding an FAQ item -All faqs are in `src/content/faq`. Each FAQ item is a markdown file with frontmatter. The frontmatter is slightly different to other pages. You need to specify which `section` the item belongs to and optionally what order it appears in the section list (`sectionOrder`). +All faqs are in `src/content/troubleshooting/faq` directory. Each FAQ item is a markdown file with frontmatter. The frontmatter is slightly different to other pages. You need to specify which `section` the item belongs to and optionally what order it appears in the section list (`sectionOrder`). To add an FAQ item to an existing section, create a new `.md` or `.mdx` file. It'll automatically get added to the FAQ index page. diff --git a/src/content/storybook/setup.mdx b/src/content/storybook/setup.mdx index 4aba91e6..533a7257 100644 --- a/src/content/storybook/setup.mdx +++ b/src/content/storybook/setup.mdx @@ -378,10 +378,3 @@ If styles are not rendering correctly, there could be several reasons behind tha If you have additional questions, use our **in-app chat** to contact or email us at [support@chromatic.com](mailto:support@chromatic.com). - -
-What is my build failing with component errors? - -When a story fails to render it will be badged with “Component Error”. You will not be able to “pass” a build that has component errors. Fix story errors in Storybook and run the build again. - -
diff --git a/src/content/troubleshooting/faq/build-fails-component-errors.md b/src/content/troubleshooting/faq/build-fails-component-errors.md new file mode 100644 index 00000000..e2e0c681 --- /dev/null +++ b/src/content/troubleshooting/faq/build-fails-component-errors.md @@ -0,0 +1,12 @@ +--- +layout: "../../../layouts/FAQLayout.astro" +sidebar: { hide: true } +title: Why is my build failing with component errors? +section: "uiTestsAndReview" +--- + +# Why is my build failing with component errors? + +When a test fails to render, the associated build will be badged with a "Component error" label. This means that Chromatic cannot render one or more components, which will prevent you from accepting the changes and passing the build. We recommend fixing the associated errors and re-running the build to ensure your tests pass. If you need guidance on fixing the errors, please refer to our [troubleshooting snapshots guide](/docs/troubleshooting-snapshots). + +If you're still having trouble, contact us via our in-app chat or email us at support@chromatic.com.