docs: improve faq

Rel1cx · Rel1cx · commit 4355255217b5 · 2024-06-22T14:20:27.000+08:00
diff --git a/README.md b/README.md
@@ -98,6 +98,10 @@ export default [
 
 [Rules Overview ↗](https://eslint-react.xyz/rules/overview)
 
+## FAQ
+
+[Frequently Asked Questions ↗](https://eslint-react.xyz/docs/faq)
+
 ## Contributing
 
 Before you start working on something, it's best to check if there is an existing issue first. It's also a good idea to reach the maintainer and confirm if it makes sense or if someone else is already working on it.
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.5.17-next.5
+1.5.17-next.6
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/monorepo",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "private": true,
   "description": "A series of composable ESLint rules for libraries and frameworks that use React as a UI runtime.",
   "keywords": [
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/core",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's ESLint utility module for static analysis of React core APIs and Patterns.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-debug/package.json b/packages/plugins/eslint-plugin-react-debug/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-debug",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's ESLint plugin for debugging related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-dom/package.json b/packages/plugins/eslint-plugin-react-dom/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-dom",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's ESLint plugin for React DOM related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-hooks-extra/package.json b/packages/plugins/eslint-plugin-react-hooks-extra/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-hooks-extra",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's ESLint plugin for React Hooks related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-naming-convention/package.json b/packages/plugins/eslint-plugin-react-naming-convention/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-naming-convention",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's ESLint plugin for naming convention related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-x/package.json b/packages/plugins/eslint-plugin-react-x/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-x",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's ESLint plugin for React related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin/README.md b/packages/plugins/eslint-plugin/README.md
@@ -98,6 +98,10 @@ export default [
 
 [Rules Overview ↗](https://eslint-react.xyz/rules/overview)
 
+## FAQ
+
+[Frequently Asked Questions ↗](https://eslint-react.xyz/docs/faq)
+
 ## Contributing
 
 Before you start working on something, it's best to check if there is an existing issue first. It's also a good idea to reach the maintainer and confirm if it makes sense or if someone else is already working on it.
diff --git a/packages/plugins/eslint-plugin/package.json b/packages/plugins/eslint-plugin/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/eslint-plugin",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "The main ESLint plugin of ESLint React. Contains all the rules and presets of ESLint React.",
   "keywords": [
     "eslint",
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/tools/package.json b/packages/tools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/tools",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's std library and primitives.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/types/package.json b/packages/types/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/types",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's type definitions.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/utilities/ast/package.json b/packages/utilities/ast/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/ast",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's TSESTree AST primitive utility module.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/utilities/jsx/package.json b/packages/utilities/jsx/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/jsx",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "ESLint React's TSESTree AST utility module for static analysis of JSX.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/utilities/var/package.json b/packages/utilities/var/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/var",
-  "version": "1.5.17-next.5",
+  "version": "1.5.17-next.6",
   "description": "TSESTree AST utility module for static analysis of variables",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/website/next.config.mjs b/website/next.config.mjs
@@ -27,6 +27,11 @@ const nextConfig = {
     unoptimized: true,
   },
   output: "standalone",
+  redirects: {
+    source: "/faq",
+    destination: "/docs/faq",
+    permanent: true,
+  },
 };
 
 export default withVanillaExtract(withNextra(nextConfig));
diff --git a/website/pages/docs/faq.md b/website/pages/docs/faq.md
@@ -2,15 +2,21 @@
 
 ## What is the purpose of `eslint-react`?
 
-The purpose of `eslint-react` is to provide ESLint rules for not just for React DOM but also other libraries and frameworks that use React as a runtime.
+The purpose of `eslint-react` is to provide ESLint plugins for not just for React DOM but also other libraries and frameworks that use React as a runtime. Currently, it provides:
 
-## What are the differences between `@eslint-react/eslint-plugin` and `eslint-plugin-react`?
+- `eslint-plugin-react-x` - Core rules (DOM Irrelevant, Render Target Agnostic, Formatting Independent).
+- `eslint-plugin-react-dom` - DOM specific rules for React DOM.
+- `eslint-plugin-react-debug` - Debugging rules.
+- `eslint-plugin-react-hooks-extra` - Extra React Hooks rules.
+- `eslint-plugin-react-naming-convention` - Naming convention rules.
 
-The main difference is when using `@eslint-react/eslint-plugin` you can customize the behavior of the rules depending on the what render target you are using. While `eslint-plugin-react` will always assume you are using React DOM even if you are working with a project that only uses React Three Fiber (You can learn more through encounters like [1] in [2]).
+## What are the differences between `eslint-plugin-react-x` and `eslint-plugin-react`?
 
-## Is `@eslint-react/eslint-plugin` a replacement for `eslint-plugin-react`?
+The main difference is when using `eslint-plugin-react-x` you can customize the behavior of the rules depending on the what render target you are using. **While `eslint-plugin-react` will always assume you are using `React DOM`** even if you are working with a project that only uses React Three Fiber (You can learn more through encounters like [1] in [2]).
 
-No, `@eslint-react/eslint-plugin` is not meant to be a drop-in replacement for `eslint-plugin-react`. But you can still using it as a replacement if you want to. Keep in mind that certain rules may behave differently, and the rules provided by `eslint-react` are more adhere to [react.dev](https://react.dev/).
+## Is `eslint-plugin-react-x` a replacement for `eslint-plugin-react`?
+
+No, `eslint-plugin-react-x` is not meant to be a drop-in replacement for `eslint-plugin-react`. But you can still using it as a replacement if you want to. Keep in mind that certain rules may behave differently, and the rules provided by `eslint-react` are more adhere to [react.dev](https://react.dev/).
 
 [1]: https://github.com/pmndrs/react-three-fiber/discussions/2487
 [2]: https://github.com/jsx-eslint/eslint-plugin-react/issues/3423#issuecomment-1930936266

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@eslint-react/monorepo",`
`3`		`- "version": "1.5.17-next.5",`
	`3`	`+ "version": "1.5.17-next.6",`
`4`	`4`	`"private": true,`
`5`	`5`	`"description": "A series of composable ESLint rules for libraries and frameworks that use React as a UI runtime.",`
`6`	`6`	`"keywords": [`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@eslint-react/core",`
`3`		`- "version": "1.5.17-next.5",`
	`3`	`+ "version": "1.5.17-next.6",`
`4`	`4`	`"description": "ESLint React's ESLint utility module for static analysis of React core APIs and Patterns.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-debug",`
`3`		`- "version": "1.5.17-next.5",`
	`3`	`+ "version": "1.5.17-next.6",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for debugging related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-dom",`
`3`		`- "version": "1.5.17-next.5",`
	`3`	`+ "version": "1.5.17-next.6",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for React DOM related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-hooks-extra",`
`3`		`- "version": "1.5.17-next.5",`
	`3`	`+ "version": "1.5.17-next.6",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for React Hooks related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-naming-convention",`
`3`		`- "version": "1.5.17-next.5",`
	`3`	`+ "version": "1.5.17-next.6",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for naming convention related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-x",`
`3`		`- "version": "1.5.17-next.5",`
	`3`	`+ "version": "1.5.17-next.6",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for React related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`