Skip to content

Commit

Permalink
docs: add headless concept section to general concepts guide (refined…
Browse files Browse the repository at this point in the history
  • Loading branch information
BatuhanW authored Jan 31, 2024
1 parent f845089 commit 7a33e6c
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 42 deletions.
12 changes: 12 additions & 0 deletions documentation/docs/guides-concepts/general-concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ title: General Concepts

Refine is an extensible framework designed for rapidly building web applications. It offers a modern, **hook-based architecture**, a **pluggable system of providers**, and a robust **state management** solution. This section provides an overview of the key concepts in Refine.

## Headless Concept

While Refine offers various integrations for different routers, UI libraries, authentication, authorization, notification providers, and more, at it's core, all these integrations are built on top of `@refinedev/core` package.

The `@refinedev/core` package is designed with **library agnostic** principles, acts as a central contract for all other Refine integrations by providing **unified interfaces**, **hooks**, and **components**.

Integrations such as `@refinedev/nextjs`, or `@refinedev/mui`, are simple wrappers between the underlying libraries and `@refinedev/core`.

This makes it straightforward to mix & match different frameworks, libraries, and integrations according to your needs.

If you want to redirect users to a certain page after a form submission, show a notification after a successful mutation, or redirect unauthenticated users to login page, you don't need to use different APIs for different libraries.

## Resource Concept

In Refine, a **resource** is a central concept representing an **entity**, which ties together various aspects of your application.
Expand Down
60 changes: 19 additions & 41 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"@commitlint/config-conventional": "^17.0.0",
"@lerna/filter-options": "^6.2.0",
"@netlify/plugin-nextjs": "4.32.2",
"@nrwl/nx-cloud": "^16.5.2",
"@nrwl/nx-cloud": "^16.0.4",
"@types/jest": "^29.2.4",
"@types/react": "^18.0.0",
"@types/react-dom": "^18.0.0",
Expand Down

0 comments on commit 7a33e6c

Please sign in to comment.