Skip to content

Commit

Permalink
Merge pull request #565 from chromaui/docs_move_storybook_error_secti…
Browse files Browse the repository at this point in the history
…on_into_faq

Docs: Adjust FAQ entry
  • Loading branch information
winkerVSbecks authored Sep 12, 2024
2 parents 3e31912 + 29d198b commit 2c8fe03
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 0 additions & 7 deletions src/content/storybook/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected]).

</details>

<details>
<summary>What is my build failing with component errors?</summary>

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.

</details>
12 changes: 12 additions & 0 deletions src/content/troubleshooting/faq/build-fails-component-errors.md
Original file line number Diff line number Diff line change
@@ -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 [email protected].

0 comments on commit 2c8fe03

Please sign in to comment.