Skip to content

Commit 5199a72

Browse files
authored
docs(website): add under construction callouts and refine pages (#1851)
1 parent a5b0224 commit 5199a72

38 files changed

Lines changed: 98 additions & 83 deletions

File tree

apps/website/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ All notable changes to the `apps/website` documentation and its content.
66

77
### 📝 Documentation
88

9+
- Added "Under Construction" callouts to documentation pages still in development (`community.mdx`, `contributing.mdx`, `diagrams.mdx`, `examples.mdx`, `packages/index.mdx`, `recipes/index.mdx`, `removed.md`, `roadmap.md`).
910
- Added missing inline table of contents to `contributing.mdx`.
11+
- Refactored `packages/index.mdx` to focus on utility packages for building custom rules, replacing the full monorepo package listing with a card-based layout highlighting `@eslint-react/kit` and adding external resources.
12+
- Refactored `recipes/index.mdx` to use card-based layouts instead of tables for recipe listings.
1013
- Removed `no-multiple-children-in-title` recipe; the same check can be enforced by leveraging type system to restrict the `children` type accepted by `<title>` components. (Consider suggesting an update to the `<title>` children type definition in `@types/react` or `@types/react-dom`.)
14+
- Removed the `` prefix from recipe titles across the recipes section for cleaner headings.
1115
- Reworked the **Brand Assets** documentation page: removed the **Icons** section, added an under-construction callout, and migrated the page from `.md` back to `.mdx`; hidden from navigation (`!brand-assets`) pending completion.
1216
- Updated `kit.mdx` callout example and AST explanation.
1317
- Updated default React fallback version references to `19.2.7` across analyzer and kit docs (#1827).

apps/website/content/docs/community.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ import { BskyPost } from "@/components/BskyPost";
77
import { GitHubRepoGrid } from "@/components/GitHubRepoGrid";
88
import { projects, presets } from "./community.tsx";
99

10+
<Callout type="warn" title="Under Construction">
11+
This page is under construction.
12+
</Callout>
13+
1014
## OSS Projects Using ESLint React
1115

1216
<GitHubRepoGrid repos={projects} />

apps/website/content/docs/configuration/configure-analyzer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ This allows rules to align their behavior with the React Compiler's optimization
5454

5555
## Advanced Configuration
5656

57-
<Callout type="warning">
57+
<Callout type="warn">
5858
The basic configuration is sufficient for most projects. Over-reliance on advanced configuration options will reduce the portability of your code across different tooling ecosystems.
5959
</Callout>
6060

apps/website/content/docs/configuration/configure-project-config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The following rules require type information:
3030
- [`react-x/no-leaked-conditional-rendering`](/docs/rules/no-leaked-conditional-rendering)
3131
- [`react-x/no-unused-props`](/docs/rules/no-unused-props)
3232

33-
<Callout type="warning">
33+
<Callout type="warn">
3434
Some rules, such as `react-x/no-leaked-conditional-rendering`, work better when certain TypeScript compiler options are enabled. We recommend enabling `strictNullChecks` in your `tsconfig.json` or `jsconfig.json`:
3535

3636
```json

apps/website/content/docs/configuration/configure-project-rules.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Configure Project Rules"
44

55
Configure [Project Rules](/docs/glossary#project-rules) using `@eslint-react/kit`.
66

7-
<Callout type="warning">
7+
<Callout type="warn">
88
This module is currently in **beta**. APIs may change in future releases.
99
</Callout>
1010

apps/website/content/docs/contributing.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ full: true
66

77
import { InlineTOC } from "fumadocs-ui/components/inline-toc";
88

9+
<Callout type="warn" title="Under Construction">
10+
This page is under construction.
11+
</Callout>
12+
913
Contributions are welcome!
1014

1115
This project does not have contributing guidelines. Explore the repository to learn how to contribute.

apps/website/content/docs/diagrams.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ import {
1010
} from "./diagrams.tsx";
1111
import { InlineTOC } from "fumadocs-ui/components/inline-toc";
1212

13+
<Callout type="warn" title="Under Construction">
14+
This page is under construction.
15+
</Callout>
16+
1317
<InlineTOC items={toc}>Table of Contents</InlineTOC>
1418

1519
## Function Component Collector Sequence

apps/website/content/docs/examples.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Examples
33
description: Start quickly from ready-to-use ESLint React example projects
44
---
55

6+
<Callout type="warn" title="Under Construction">
7+
This page is under construction.
8+
</Callout>
9+
610
## Example Projects
711

812
If you prefer to start from a working setup, you can use one of the official example projects:

apps/website/content/docs/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ For users who use the presets we provide (such as `recommended` or `strict`), it
6565

6666
For users who need more fine-grained control or build and maintain an ESLint configuration for themselves or their organization, it is recommended to use individual plugins. This allows you to freely select plugins and compose rules as needed, without being limited by presets.
6767

68-
<Callout type="warning">
68+
<Callout type="warn">
6969
The unified plugin (`@eslint-react/eslint-plugin`) contains some historical decisions and internal behaviors that were originally made to be compatible with both [Legacy Config](https://eslint.org/docs/v8.x/use/configure/configuration-files) and [Flat Config](https://eslint.org/docs/v8.x/use/configure/configuration-files-new). Reducing external package dependencies on it is better in the long run.
7070
</Callout>
7171

apps/website/content/docs/migrating-from-eslint-plugin-react.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ESLint React is a collection of ESLint plugins and utilities for React, with a f
1818

1919
## Rule Comparison Table
2020

21-
<Callout type="warning">
21+
<Callout type="warn">
2222
Not all rules have direct equivalents, and some behave differently.
2323
</Callout>
2424

0 commit comments

Comments
 (0)