docs: update

Author: antfu

README.md

@@ -8,7 +8,10 @@
   </a>
 </p>
 
-Collection of [ESLint](https://eslint.org)-related packages for Nuxt ✨
+Collection of ESLint-related packages for Nuxt,
+provides project-aware, easy-to-use, extensible and future-proof integrations.
+
+Refer to the [documentation](https://eslint.nuxt.com) for more details.
 
 ## Packages
 

docs/content/1.packages/0.module.md

@@ -2,9 +2,9 @@
 title: ESLint Module
 ---
 
-This module that generates project-aware [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new) for Nuxt.
+All-in-one ESLint integrations for Nuxt. It generates project-aware [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new) and provides the ability to optionally runs ESLint check along the dev server.
 
-:::callout{icon="i-heroicons-light-bulb"}
+:::callout{icon="i-ph-lightbulb-duotone"}
 This module is designed for the [new ESLint flat config format](https://eslint.org/docs/latest/use/configure/configuration-files-new), which will be as default in ESLint v9.
 The legacy `.eslintrc` config is **not supported**. We highly recommand you to migrate over the flat config to be future-proof. If you still want to use the legacy format, you might need to manually config with [`@nuxt/eslint-config`](/packages/configs), which will also lost some features like project-aware settings.
 :::

docs/content/1.packages/1.config.md

@@ -2,9 +2,9 @@
 title: '@nuxt/eslint-config'
 ---
 
-A shared ESLint config for Nuxt 3 projects.
+Shared ESLint config for Nuxt 3 projects. Unopinionated by default, but customizable.
 
-:::callout{icon="i-heroicons-light-bulb"}
+:::callout{icon="i-ph-lightbulb-duotone"}
 We recommand to use directly the [ESLint Module](/packages/module) that will provide project-aware ESLint config and Nuxt DevTools integration on top of this config.
 :::
 
@@ -13,10 +13,12 @@ We recommand to use directly the [ESLint Module](/packages/module) that will pro
 This package provides two different ESLint configs:
 
 - [Flat Config](#flat-config-format) - Customizable, future-proof, config for the [new flat config format](https://eslint.org/docs/latest/use/configure/configuration-files-new).
-- [Legacy Config](#legacy-config-format) - Opinionated, Static, config for the legacy `.eslintrc` format. 
+- [Legacy Config](#legacy-config-format) - Unopinionated, Static, config for the legacy `.eslintrc` format. 
 
 ## Flat Config Format
 
+The flat config format is the future of ESLint and is designed to be more flexible and project-aware. The entry `@nuxt/eslint-plugin/flat` provides a factory function to create a project-aware ESLint config for Nuxt 3 projects. Unopinionated by default, but customizable by passing options to the factory function. Used by [`@nuxt/eslint`](/packages/module) module to generate project-aware ESLint config.
+
 1. Install this package and `eslint` in your `devDependencies`.
 
 ```bash
@@ -49,6 +51,8 @@ You might also want to add a script entry to your `package.json:
 
 ## Legacy Config Format
 
+The legacy config configures for TypeScript and Vue integrations for ESLint. It is unopinionated and static, that does not contains stylistic rules nor project-aware settings.
+
 1. Install this package and `eslint` in your `devDependencies`.
 
 ```bash

docs/content/1.packages/2.plugin.md

@@ -4,7 +4,7 @@ title: '@nuxt/eslint-plugin'
 
 ESLint plugin of additional rules for Nuxt 3.
 
-:::callout{icon="i-heroicons-light-bulb"}
+:::callout{icon="i-ph-lightbulb-duotone"}
 Usually, you don't need to use this package directly. It's already included in the [ESLint Module](/packages/module) and the [ESLint Config](/packages/config).
 :::
 

docs/content/2.guide/0.faq.md

@@ -26,8 +26,8 @@ Here's a table to help you understand the differences:
 | [`@nuxt/eslint`](/packages/module) <br> All-in-one ESLint module for Nuxt 3 | [`nuxt3`]{.badge-nuxt3} [`flat-config`]{.badge-flat} [`recommended`]{.badge-recommend} |
 | [`@nuxt/eslint-config`](/packages/config) <br> Shared config for Nuxt 3, for both flat config and legacy config. <br>Unopinionated but customizable. | [`nuxt3`]{.badge-nuxt3} [`flat-config`]{.badge-flat} [`legacy-config`]{.badge-legacy} |
 | [`@nuxt/eslint-plugin`](/packages/plugin) <br> Low-level ESLint plugin for Nuxt 3. | [`nuxt3`]{.badge-nuxt3} |
-| [`@nuxtjs/eslint-module`](/packages/module) <br> Runs ESLint check along the dev server. <br> Now merged into `@nuxt/eslint` module. | [`nuxt3`]{.badge-nuxt3} [`nuxt2`]{.badge-nuxt2} [`deprecated`]{.badge-legacy} |
-| [`@nuxtjs/eslint-config`](/packages/config) <span class="opacity-50">(note the `@nuxtjs` scope)</span> <br> Shared config for Nuxt 2, opinionated with stylistic rules.<br> Maintainance mode, no long have active developments. | [`nuxt2`]{.badge-nuxt2} [`legacy-config`]{.badge-legacy} |
-| [`@nuxtjs/eslint-plugin-typescript`](/packages/plugin) <span class="opacity-50">(note the `@nuxtjs` scope)</span> <br> TypeScript integrations for `@nuxtjs/eslint-config`.<br> Maintainance mode, no long have active developments. | [`nuxt2`]{.badge-nuxt2} [`legacy-config`]{.badge-legacy} |
+| [`@nuxtjs/eslint-module`](/legacy/eslint-module) <br> Runs ESLint check along the dev server. <br> Now merged into `@nuxt/eslint` module. | [`nuxt3`]{.badge-nuxt3} [`nuxt2`]{.badge-nuxt2} [`deprecated`]{.badge-legacy} |
+| [`@nuxtjs/eslint-config`](/legacy/eslint-config) <span class="opacity-50">(note the `@nuxtjs` scope)</span> <br> Shared config for Nuxt 2, opinionated with stylistic rules.<br> Maintainance mode, no long have active developments. | [`nuxt2`]{.badge-nuxt2} [`legacy-config`]{.badge-legacy} |
+| [`@nuxtjs/eslint-plugin-typescript`](/legacy/eslint-config) <span class="opacity-50">(note the `@nuxtjs` scope)</span> <br> TypeScript integrations for `@nuxtjs/eslint-config`.<br> Maintainance mode, no long have active developments. | [`nuxt2`]{.badge-nuxt2} [`legacy-config`]{.badge-legacy} |
 
 </div>

docs/content/3.legacy/1.eslint-config.md

@@ -1,3 +1,56 @@
 ---
 title: '@nuxtjs/eslint-config'
 ---
+
+Opinionated [ESlint](https://eslint.org/) configuration used internally for Nuxt 2 projects.
+
+:::callout{icon="i-ph-lightbulb-duotone"}
+This package is for Nuxt 2. For Nuxt 3 projects, use [`@nuxt/eslint`](/packages/module) instead.<br>
+:::
+
+:::callout{icon="i-ph-warning-circle-duotone" color="amber"}
+This package is in maintainance mode and no longer have active developments.
+:::
+
+### Usage
+
+1. Add this package to your `devDependencies`
+
+```bash
+$ npm i -D @nuxtjs/eslint-config
+# or
+$ yarn add -D @nuxtjs/eslint-config
+```
+
+2. Install `eslint` if not already present locally or globally
+
+```bash
+$ npm i -D eslint
+# or
+$ yarn add -D eslint
+```
+
+3. Create a `.eslintrc` file
+
+4. Extend our config (you can use just the scope name as ESLint will assume the `eslint-config` prefix):
+
+```json
+{
+  "extends": ["@nuxtjs/eslint-config"]
+}
+```
+
+### TypeScript
+
+If you're using TypeScript, follow [Usage](#usage) section by replacing `@nuxtjs/eslint-config` by `@nuxtjs/eslint-config-typescript`.
+
+And in your `.eslintrc` all you need is :
+
+```json
+{
+  "extends": ["@nuxtjs/eslint-config-typescript"]
+}
+```
+
+You can then edit/override same rules as you could with `@nuxtjs/eslint-config` but also TypeScript rules.
+You can find the list of supported TypeScript rules [here](https://typescript-eslint.io/rules/#supported-rules) and you can read more about Nuxt's TypeScript support [in the docs](https://nuxt.com/docs/guide/concepts/typescript).

docs/content/3.legacy/2.eslint-module.md

@@ -0,0 +1,5 @@
+---
+title: '@nuxtjs/eslint-module'
+---
+
+Runs ESLint check along the dev server. Now merged into the [`@nuxt/eslint`](/packages/eslint) module.

packages-legacy/nuxt2-eslint-config-typescript/README.md

@@ -4,8 +4,6 @@
 [![npm](https://flat.badgen.net/npm/dm/@nuxtjs/eslint-config)](https://npmjs.com/package/@nuxtjs/eslint-config)
 [![npm (scoped with tag)](https://flat.badgen.net/npm/v/@nuxtjs/eslint-config)](https://npmjs.com/package/@nuxtjs/eslint-config)
 
-> Opinionated [ESlint](https://eslint.org/) configuration used internally by Nuxt projects.
+Opinionated [ESlint](https://eslint.org/) configuration for Nuxt 2.
 
-### Usage
-
-Check docs in [`@nuxtjs/eslint-config`](../eslint-config-legacy/)
+Refer to the [documentation](https://eslint.nuxt.com/legacy/eslint-config) for more details.

packages-legacy/nuxt2-eslint-config/README.md

@@ -4,66 +4,6 @@
 [![npm](https://flat.badgen.net/npm/dm/@nuxtjs/eslint-config)](https://npmjs.com/package/@nuxtjs/eslint-config)
 [![npm (scoped with tag)](https://flat.badgen.net/npm/v/@nuxtjs/eslint-config)](https://npmjs.com/package/@nuxtjs/eslint-config)
 
-> Opinionated [ESlint](https://eslint.org/) configuration used internally by Nuxt projects.
+Opinionated [ESlint](https://eslint.org/) configuration for Nuxt 2.
 
-### Usage
-
-Do you want to add the config to your own projects? There you go:
-
-1. Add this package to your devDependencies
-
-```bash
-$ npm i -D @nuxtjs/eslint-config
-# or
-$ yarn add -D @nuxtjs/eslint-config
-```
-
-2. Install `eslint` if not already present locally or globally
-
-```bash
-$ npm i -D eslint
-# or
-$ yarn add -D eslint
-```
-
-3. Create a `.eslintrc` file
-
-4. Extend our config (you can use just the scope name as ESLint will assume the `eslint-config` prefix):
-
-```json
-{
-  "extends": ["@nuxtjs/eslint-config"]
-}
-```
-
-### Full example
-
-A full example `.eslintrc` for a project with babel support:
-
-> Dont forget to `npm i -D @babel/eslint-parser` or `yarn add -D @babel/eslint-parser`
-
-```json
-{
-  "root": true,
-  "parser": "@babel/eslint-parser",
-  "parserOptions": {
-    "sourceType": "module"
-  },
-  "extends": ["@nuxt/eslint-config"],
-}
-```
-
-### TypeScript
-
-If you're using TypeScript, follow [Usage](#usage) section by replacing `@nuxtjs/eslint-config` by `@nuxtjs/eslint-config-typescript`.
-
-And in your `.eslintrc` all you need is :
-
-```json
-{
-  "extends": ["@nuxtjs/eslint-config-typescript"]
-}
-```
-
-You can then edit/override same rules as you could with `@nuxtjs/eslint-config` but also TypeScript rules.
-You can find the list of supported TypeScript rules [here](https://typescript-eslint.io/rules/#supported-rules) and you can read more about Nuxt's TypeScript support [in the docs](https://nuxt.com/docs/guide/concepts/typescript).
+Refer to the [documentation](https://eslint.nuxt.com/legacy/eslint-config) for more details.

packages/eslint-config/README.md

@@ -3,41 +3,9 @@
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 
-> Non-opinionated [ESlint](https://eslint.org/) configuration for Nuxt 3 apps.
+Shared ESLint config for Nuxt 3 projects. Unopinionated by default, but customizable.
 
-### Features
-
-- Works out-of-the-box with no additional configuration.
-- Nuxt-specific rules for pages, components and more.
-
-### Installation
-
-1. Install this package and `eslint` in your `devDependencies`.
-
-```bash
-npm i -D @nuxt/eslint-config eslint
-yarn add -D @nuxt/eslint-config eslint
-pnpm add -D @nuxt/eslint-config eslint
-```
-
-2. Extend the default Nuxt config by creating an `.eslintrc.cjs`:
-
-```js
-module.exports = {
-  root: true,
-  extends: ["@nuxt/eslint-config"],
-};
-```
-
-You might also want to add a script entry to your `package.json:
-
-```json
-{
-  "scripts": {
-    "lint": "eslint ."
-  }
-}
-```
+Refer to the [documentation](https://eslint.nuxt.com/packages/config) for more details.
 
 <!-- Badges -->