Skip to content

Commit e3386ed

Browse files
committed
feat(docs): convert FAQ to MDX format with accordion components
1 parent 223a0e7 commit e3386ed

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

website/content/docs/faq.md renamed to website/content/docs/faq.mdx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22
title: FAQ
33
---
44

5-
## Why create `eslint-react`?
5+
import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';
6+
7+
<Accordions>
8+
9+
<Accordion title="Why create eslint-react?">
610

711
The existing `eslint-plugin-react` is a plugin for `react-dom` but named react[¹], it only supports React DOM[²] and does not being expected to be used with x-platform.
812

@@ -12,7 +16,9 @@ Unfortunately, the maintainers of `eslint-plugin-react` refuse to change that[
1216

1317
Just as in [Beyond the DOM](https://legacy.reactjs.org/docs/design-principles.html#beyond-the-dom) we believe that the community will benefit from a renderer-agnostic and x-platform-supported plugin. This is also the initial motivation for creating `eslint-react`.
1418

15-
## What is included in `eslint-react`?
19+
</Accordion>
20+
21+
<Accordion title="What is included in eslint-react?">
1622

1723
Currently, it includes the following plugins:
1824

@@ -25,12 +31,18 @@ Currently, it includes the following plugins:
2531

2632
You can view our long-term plans on the [roadmap](/roadmap#plugins-with-ecological-niche-explanation).
2733

28-
## Is there anything to note about migrating from `eslint-plugin-react` to `eslint-react`?
34+
</Accordion>
35+
36+
<Accordion title="Is there anything to note about migrating from eslint-plugin-react to eslint-react?">
2937

3038
Please be aware that some rules may behave differently when transitioning to `eslint-react`. The rules in `eslint-react` are more closely aligned with the guidelines provided by [react.dev](https://react.dev). This alignment is due to `eslint-react` adopting [react.dev](https://react.dev) as its primary reference, rather than `eslint-plugin-react`.
3139

3240
To smoothly transition, we suggest reviewing the rules in `eslint-react` and running a comprehensive linting check on your codebase to identify and address any discrepancies introduced by the migration.
3341

42+
</Accordion>
43+
44+
</Accordions>
45+
3446
[¹]: https://github.com/jsx-eslint/eslint-plugin-react/issues/3423#issuecomment-1930936266
3547
[²]: https://github.com/jsx-eslint/eslint-plugin-react/issues/3423#issuecomment-1314565853
3648
[³]: https://github.com/pmndrs/gltf-react-three/issues/38#issuecomment-2057794974

0 commit comments

Comments
 (0)