Skip to content

Fix readme two #1351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
singhtrivendra merged 3 commits into from
Jun 16, 2026
Merged

Fix readme two #1351

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aab8a7a
docs: add table of contents to README
Neverask1121 Jun 15, 2026
cb2f20f
docs: add project structure section to README
Neverask1121 Jun 15, 2026
0c87d11
Merge branch 'main' into fix-readme-two
Neverask1121 Jun 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,55 @@ Currently, two official plugins are available:
- [React Compiler](#react-compiler)
- [Expanding the ESLint Configuration](#expanding-the-eslint-configuration)

## Project Structure

```text
.
├── .github/
│ ├── ISSUE_TEMPLATE/ # GitHub issue templates
│ └── workflows/ # GitHub Actions workflows
├── components/ # Shared project components
├── public/
│ ├── favicon.svg # Website favicon
│ └── icons.svg # SVG icon assets
├── src/
│ ├── assets/ # Images and static resources
│ ├── components/
│ │ ├── cards/
│ │ ├── nature-and-sea/
│ │ └── wild-cards/
│ ├── context/ # React context providers
│ ├── data/ # Application data and configuration
│ ├── pages/ # Application pages/routes
│ ├── registry/ # Registry definitions
│ ├── App.tsx # Root application component
│ ├── App.css # App-specific styles
│ ├── index.css # Global styles
│ └── main.tsx # Application entry point
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── eslint.config.js
├── index.html
├── License.md
├── package.json
├── package-lock.json
└── postcss.config.js
```

### Directory Overview

| Directory | Purpose |
|------------|---------|
| `.github/` | Repository templates and GitHub Actions workflows |
| `public/` | Static assets served directly by Vite |
| `src/assets/` | Images, icons, and other resources |
| `src/components/` | Reusable React components |
| `src/context/` | Global React Context providers |
| `src/data/` | Application data and configuration |
| `src/pages/` | Page-level components |
| `src/registry/` | Registry definitions and mappings |

## React Compiler

The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
Expand Down
Loading