docs: update project description

Author: Rel1cx

README.md

@@ -6,7 +6,9 @@
 [![Size](https://img.shields.io/bundlephobia/minzip/@eslint-react/eslint-plugin?label=gzip&style=flat&colorA=000000&colorB=000000)](https://bundlephobia.com/package/@eslint-react/eslint-plugin)
 [![Downloads](https://img.shields.io/npm/dt/@eslint-react/eslint-plugin.svg?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/@eslint-react/eslint-plugin)
 
-More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).
+## What is this?
+
+It's a platform for creating ESLint rules for not just for ReactDOM but also other libraries and frameworks that use React as a runtime.
 
 ## Highlights
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eslint-react/monorepo",
   "version": "0.10.12",
-  "description": "ESLint React's monorepo. More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).",
+  "description": "ESLint React's monorepo. A platform for creating ESLint rules for not just for ReactDOM but also other libraries and frameworks that use React as a runtime.",
   "keywords": [
     "eslint",
     "eslint-plugin",

packages/plugins/eslint-plugin/README.md

@@ -2,147 +2,4 @@
 
 <h1 align="center" alt="title">ESLint React</h1>
 
-[![Version](https://img.shields.io/npm/v/@eslint-react/eslint-plugin?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/@eslint-react/eslint-plugin)
-[![Size](https://img.shields.io/bundlephobia/minzip/@eslint-react/eslint-plugin?label=gzip&style=flat&colorA=000000&colorB=000000)](https://bundlephobia.com/package/@eslint-react/eslint-plugin)
-[![Downloads](https://img.shields.io/npm/dt/@eslint-react/eslint-plugin.svg?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/@eslint-react/eslint-plugin)
-
-More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).
-
-## Highlights
-
-- Well designed rule behaviors and sensible defaults.
-- Maximum flexibility through minimum configuration options.
-- No auto-fix, Formatting independent, treat your codebase like it's read-only.
-
-## Supported React versions
-
-- 18.2.0 or later
-
-## Supported engines
-
-### Node.js
-
-- 18.18.0 or later
-
-### Bun
-
-- 1.0.15 or later
-
-### Install
-
-```sh
-# npm
-npm install --save-dev @eslint-react/eslint-plugin
-```
-
-### Setup
-
-Add `@eslint-react` to the plugins section of your `.eslintrc.js` configuration file.
-
-```js
-module.exports = {
-  // ...
-  parser: "@typescript-eslint/parser",
-  extends: ["plugin:@eslint-react/recommended-legacy"],
-  plugins: ["@eslint-react"],
-  // ...
-};
-```
-
-### Linting with type information
-
-> [!NOTE]\
-> Rules that require type information are not enabled by default.
->
-> To enable them, you need to set the `project` option in `parserOptions` to the path of your `tsconfig.json` file.
->
-> Then replace `plugin:@eslint-react/recommended-legacy` with `plugin:@eslint-react/recommended-type-checked-legacy`.
-
-```js
-module.exports = {
-  // ...
-  parser: "@typescript-eslint/parser",
-  parserOptions: {
-    project: "./tsconfig.json", // <-- Point to your project's "tsconfig.json" or create a new one.
-  },
-  extends: ["plugin:@eslint-react/recommended-type-checked-legacy"],
-  plugins: ["@eslint-react"],
-  // ...
-};
-```
-
-[Full Installation Guide ↗](https://eslint-react.xyz/docs/installation)
-
-## Presets
-
-### LegacyConfig presets
-
-> [!IMPORTANT]\
-> These presets are for ESLint `LegacyConfig` (`.eslintrc.*`) only
-
-- **recommended-legacy** (`plugin:@eslint-react/recommended-legacy`)\
-  Enforce recommended rules designed to catch common mistakes and prevent potential bugs.
-- **recommended-type-checked-legacy** (`plugin:@eslint-react/recommended-type-checked-legacy`)\
-  Same as recommended-legacy but with additional rules that require type information.
-- **debug-legacy** (`plugin:@eslint-react/debug-legacy`)\
-  Enable a series of rules that are useful for debugging purposes only.\
-  (Not recommended unless you know what you are doing)
-- **all-legacy** (`plugin:@eslint-react/all-legacy`)\
-  Enable all rules in this plugin except for debug rules.
-- **off-legacy** (`plugin:@eslint-react/off-legacy`)\
-  Disable all rules in this plugin except for debug rules.
-
-### FlatConfig presets
-
-> [!IMPORTANT]\
-> These presets are for ESLint `FlatConfig` (`eslint.config.js`) only
-
-- **recommended**\
-  Enforce recommended rules designed to catch common mistakes and prevent potential bugs.
-- **recommended-type-checked**\
-  Same as recommended but with additional rules that require type information.
-- **debug**\
-  Enable a series of rules that are useful for debugging purposes only.\
-  (Not recommended unless you know what you are doing)
-- **all**\
-  Enable all rules in this plugin except for debug rules.
-- **off**\
-  Disable all rules in this plugin except for debug rules.
-
-[Full Presets List↗](https://eslint-react.xyz/presets/overview)
-
-## Rules
-
-[Rules Overview ↗](https://eslint-react.xyz/rules/overview)
-
-## Philosophy
-
-- **Do what a linter should do**
-- **Focus on code rather than style**
-- **Rules are better than options**
-
-## Rule introduction or modification principles
-
-1. **No Auto-fix**. Auto-fix is a great feature, but it's not always safe and reliable. We prefer to not to do auto-fix at all than to implement it in a way that can cause more problems than it solves.
-2. **Formatting independent**. Rules should check for correctness, not style. We recommend using style focused tools for formatting (e.g. [dprint](https://dprint.dev/)).
-3. **Sensible defaults**. Rules should be easy to setup and use with minimal configuration and sensible defaults.
-4. **Rules over options [[1]](https://eslint-react.xyz/docs/rules-over-options)**. Each rule should have a single purpose. Make multiple rules work together to achieve more complex behaviors instead of adding options to a single rule.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## Inspiration
-
-- [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist)
-- [eslint-plugin-solid](https://github.com/solidjs-community/eslint-plugin-solid)
-- [eslint-plugin-functional](https://github.com/eslint-functional/eslint-plugin-functional)
-- [eslint-plugin-filenames-simple](https://github.com/epaew/eslint-plugin-filenames-simple)
-- [@tanstack/eslint-plugin-query](https://github.com/TanStack/query/tree/main/packages/eslint-plugin-query)
-- [rome/tools](https://github.com/rome/tools)
-- [rust-clippy](https://github.com/rust-lang/rust-clippy)
-
-## Prior art
-
-- [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react)
-- [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
+The main ESLint plugin of ESLint React. Contains all the rules and presets of ESLint React.

packages/plugins/eslint-plugin/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eslint-react/eslint-plugin",
   "version": "0.10.12",
-  "description": "More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).",
+  "description": "The main ESLint plugin of ESLint React. Contains all the rules and presets of ESLint React.",
   "keywords": [
     "eslint",
     "eslint-plugin",

website/pages/_document.tsx

@@ -6,7 +6,7 @@ import { PUBLIC_URL } from "#/constants";
 export default function Document() {
   const metaTitle = "eslint-react";
   // dprint-ignore
-  const metaDescription = "ESLint React - More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).";
+  const metaDescription = "ESLint React - A platform for creating ESLint rules for not just for ReactDOM but also other libraries and frameworks that use React as a runtime.";
 
   return (
     <Html lang="en">

website/pages/index.mdx

@@ -1,7 +1,13 @@
+import { Warning } from "#/components/callout";
 import { ESLintReactCard } from "#/components/eslint-react-card/eslint-react-card";
 
 <ESLintReactCard />
 
+<Warning>
+  Please note that the documentation is currently under construction. Some
+  sections may be incomplete or subject to changes.
+</Warning>
+
 Welcome to the ESLint React documentation.
 
-More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).
+A platform for creating ESLint rules for not just for ReactDOM but also other libraries and frameworks that use React as a runtime.

website/theme.config.tsx

@@ -25,7 +25,7 @@ export default {
       .with({ asPath: "/" }, () => ({
         title: "ESLint React",
         description:
-          "ESLint React - More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).",
+          "ESLint React - A platform for creating ESLint rules for not just for ReactDOM but also other libraries and frameworks that use React as a runtime.",
       }))
       .with({ asPath: P.string.startsWith("/rules/") }, () => ({
         titleTemplate: "Rule: %s",
@@ -40,7 +40,7 @@ export default {
       <meta property="og:title" content="ESLint React" />
       <meta
         property="og:description"
-        content="ESLint React - More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly)."
+        content="ESLint React - A platform for creating ESLint rules for not just for ReactDOM but also other libraries and frameworks that use React as a runtime."
       />
       <link
         rel="apple-touch-icon"