Improve doc

2026-08-07 16:48:24 +02:00
parent 7a4b15f894
commit 6ac2995b99
4 changed files with 14 additions and 21 deletions
@@ -6,7 +6,7 @@ Data, auth and live providers that can be used in any [Refine](https://refine.de

 > For a quick overview, have a look at our [example app](./examples/antd-app/).

-Refine relies on the concept of "resources", which are data types, to manage your application in a structured way. On the other side, NextGraph identifies data types using [ShEx shapes](https://shex.io/) which are transformed into "shape types" using [its own tool](https://docs.nextgraph.org/en/reference/shex-orm/). So naturally our data provider needs to receive a list of shape types in order to identify resources.
+Refine relies on the concept of "resources" (which are data types) to manage your application in a structured way. On the other side, NextGraph identifies data types using [ShEx shapes](https://shex.io/) which are transformed into "shape types" using [its own tool](https://docs.nextgraph.org/en/reference/shex-orm/). So naturally our data provider needs to receive a list of shape types in order to identify resources.

 ### 1. Define your shapes

@@ -54,7 +54,11 @@ const shapeTypes : ShapeTypes = {
 export default shapeTypes;
 ```

-### 3. Add the providers to Refine
+### 3. Configure the providers
+
+Add the providers to Refine. The live provider is optional, but it will allow you to sync data
+if several users are working on the same data. See the example app for how to handle this correctly
+in the edit and view pages.

 ```tsx
 import { authProvider, dataProvider, liveProvider } from "@ng-org/refine-providers";
@@ -107,4 +111,5 @@ export const PostList = () => {
 ```bash
 pnpm build
 pnpm watch
+pnpm publish
 ```