Add installation steps

djhi · djhi · commit 7b7d989dfc19 · 2025-10-07T12:18:35.000+02:00
diff --git a/docs_headless/src/content/docs/LockStatusBase.md b/docs_headless/src/content/docs/LockStatusBase.md
@@ -2,9 +2,19 @@
 title: "<LockStatusBase>"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
+`<LockStatusBase>` displays the lock status of the current record. It allows to visually indicate whether the record is locked or not, by the current user or not, and provides an easy way to lock or unlock the record.
 
-Use the `<LockStatusBase>` component to display the lock status of the record in the nearest `RecordContext`:
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
+## Usage
 
 ```tsx
 import React from 'react';
diff --git a/docs_headless/src/content/docs/useGetListLive.md b/docs_headless/src/content/docs/useGetListLive.md
@@ -2,9 +2,19 @@
 title: "useGetListLive"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
+`useGetListLive` is an alternative to `useGetList` that subscribes to live updates on the record list.
 
-Alternative to `useGetList` that subscribes to live updates on the record list.
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
+## Usage
 
 ```tsx
 import { useGetListLive } from '@react-admin/ra-core-ee';
diff --git a/docs_headless/src/content/docs/useGetLock.md b/docs_headless/src/content/docs/useGetLock.md
@@ -2,20 +2,19 @@
 title: "useGetLock"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
+A hook that gets the lock status for a record. It calls `dataProvider.getLock()` on mount.
 
-Gets the lock status for a record. It calls `dataProvider.getLock()` on mount.
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
 
-```tsx
-const { data, isLoading } = useGetLock(resource, { id });
-```
+## Installation
 
-Parameters description:
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
 
--   `resource`: the resource name (e.g. `'posts'`)
--   `params`: an object with the following properties:
-    -   `id`: the record id (e.g. `123`)
-    -   `meta`: Optional. an object that will be forwarded to the dataProvider (optional)
+## Usage
 
 Here is a form toolbar that displays the lock status of the current record:
 
@@ -45,4 +44,11 @@ const FormToolbar = () => {
         </div>
     );
 };
-```
+```
+
+## Parameters
+
+-   `resource`: the resource name (e.g. `'posts'`)
+-   `params`: an object with the following properties:
+    -   `id`: the record id (e.g. `123`)
+    -   `meta`: Optional. an object that will be forwarded to the dataProvider (optional)
diff --git a/docs_headless/src/content/docs/useGetLockLive.md b/docs_headless/src/content/docs/useGetLockLive.md
@@ -2,7 +2,19 @@
 title: "useGetLockLive"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
+A hook that gets the lock status for a record in real time.
+
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
+## Usage
 
 Use the `useGetLockLive()` hook to get the lock status in real time. This hook calls `dataProvider.getLock()` for the current record on mount, and subscribes to live updates on the `lock/[resource]/[id]` topic.
 
diff --git a/docs_headless/src/content/docs/useGetLocks.md b/docs_headless/src/content/docs/useGetLocks.md
@@ -2,15 +2,20 @@
 title: "useGetLocks"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
+A hook that gets all the locks for a given resource. Calls `dataProvider.getLocks()` on mount.
 
-Get all the locks for a given resource. Calls `dataProvider.getLocks()` on mount.
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
 
-```tsx
-// simple Usage
-const { data } = useGetLocks('posts');
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
 ```
 
+## Usage
+
 Here is how to use it in a custom list, to disable edit and delete buttons for locked records:
 
 ```tsx
diff --git a/docs_headless/src/content/docs/useGetLocksLive.md b/docs_headless/src/content/docs/useGetLocksLive.md
@@ -2,19 +2,31 @@
 title: "useGetLocksLive"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
+Use the `useGetLocksLive` hook to get all the locks for a resource in real time. 
 
-Use the `useGetLocksLive` hook to get the locks in real time. This hook calls `dataProvider.getLocks()` for the current resource on mount, and subscribes to live updates on the `lock/[resource]` topic.
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
 
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
+## Usage
+
+This hook calls `dataProvider.getLocks()` for the current resource on mount, and subscribes to live updates on the `lock/[resource]` topic.
 This means that if a lock is acquired or released by another user while the current user is on the page, the return value will be updated.
 
 ```tsx
 import { useRecordContext } from 'ra-core';
 import { useGetLocksLive } from '@react-admin/ra-core-ee';
 import { Lock } from 'lucide-react';
 
-export const LockField = ({ locks }) => {
+export const LockField = () => {
     const record = useRecordContext();
+    const locks = useGetLocksLive();
     if (!record) return null;
     const lock = locks?.find(lock => lock.recordId === record?.id);
     if (!lock) return <span className="w-4 h-4" />;
diff --git a/docs_headless/src/content/docs/useGetOneLive.md b/docs_headless/src/content/docs/useGetOneLive.md
@@ -2,9 +2,19 @@
 title: "useGetOneLive"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
+An alternative to `useGetOne()` that subscribes to live updates on the record
 
-Alternative to `useGetOne()` that subscribes to live updates on the record
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
+## Usage
 
 ```tsx
 import { useRecordContext } from 'ra-core';
diff --git a/docs_headless/src/content/docs/useLock.md b/docs_headless/src/content/docs/useLock.md
@@ -2,10 +2,20 @@
 title: "useLock"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
-
 `useLock` is a low-level hook that returns a callback to call `dataProvider.lock()`, leveraging react-query's `useMutation`.
 
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
+## Usage
+
 ```tsx
 const [lock, { isLoading, error }] = useLock(
     resource,
diff --git a/docs_headless/src/content/docs/useLockCallbacks.md b/docs_headless/src/content/docs/useLockCallbacks.md
@@ -1,10 +1,17 @@
 ---
 title: "useLockCallbacks"
 ---
+This utility hook allows to easily get the callbacks to **lock** and **unlock** a record, as well as the current **lock status**.
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
 
-This utility hook allows to easily get the callbacks to **lock** and **unlock** a record, as well as the current **lock status**.
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
 
 ## Usage
 
diff --git a/docs_headless/src/content/docs/useLockOnCall.md b/docs_headless/src/content/docs/useLockOnCall.md
@@ -2,17 +2,24 @@
 title: "useLockOnCall"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
-
-Get a callback to lock a record and get a mutation state.
-
+A hook that gets a callback to lock a record and its mutation state.
 `useLockOnCall` calls `dataProvider.lock()` when the callback is called. It relies on `authProvider.getIdentity()` to get the identity of the current user. It guesses the current `resource` and `recordId` from the context (or the route) if not provided. It releases the lock when the component unmounts by calling `dataProvider.unlock()`.
 
 <video controls autoplay playsinline muted loop>
   <source src="https://react-admin-ee.marmelab.com/assets/useLockOnCall.mp4" type="video/mp4"/>
   Your browser does not support the video tag.
 </video>
 
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
 ## Usage
 
 Use this hook in a toolbar, to let the user lock the record manually.
diff --git a/docs_headless/src/content/docs/useLockOnMount.md b/docs_headless/src/content/docs/useLockOnMount.md
@@ -2,8 +2,6 @@
 title: "useLockOnMount"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
-
 This hook locks the current record on mount.
 
 `useLockOnMount` calls `dataProvider.lock()` on mount and `dataProvider.unlock()` on unmount to lock and unlock the record. It relies on `authProvider.getIdentity()` to get the identity of the current user. It guesses the current `resource` and `recordId` from the context (or the route) if not provided.
@@ -13,6 +11,16 @@ This hook locks the current record on mount.
   Your browser does not support the video tag.
 </video>
 
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
 ## Usage
 
 Use this hook e.g. in an `<Edit>` component to lock the record so that it only accepts updates from the current user.
diff --git a/docs_headless/src/content/docs/usePublish.md b/docs_headless/src/content/docs/usePublish.md
@@ -2,14 +2,22 @@
 title: "usePublish"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
-
 Get a callback to publish an event on a topic. The callback returns a promise that resolves when the event is published.
 
 `usePublish` calls `dataProvider.publish()` to publish the event. It leverages react-query's `useMutation` hook to provide a callback.
 
 **Note**: Events should generally be published by the server, in reaction to an action by an end user. They should seldom be published directly by the client. This hook is provided mostly for testing purposes, but you may use it in your own custom components if you know what you're doing.
 
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
 ## Usage
 
 `usePublish` returns a callback with the following signature:
diff --git a/docs_headless/src/content/docs/useSubscribe.md b/docs_headless/src/content/docs/useSubscribe.md
@@ -2,15 +2,23 @@
 title: "useSubscribe"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
-
 Subscribe to the events from a topic on mount (and unsubscribe on unmount).
 
 <video controls autoplay playsinline muted loop>
   <source src="https://react-admin-ee.marmelab.com//assets/useSubscribe.mp4" type="video/mp4"/>
   Your browser does not support the video tag.
 </video>
 
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
 ## Usage
 
 The following component subscribes to the `messages/{channelName}` topic and displays a badge with the number of unread messages:
diff --git a/docs_headless/src/content/docs/useSubscribeCallback.md b/docs_headless/src/content/docs/useSubscribeCallback.md
@@ -2,8 +2,6 @@
 title: "useSubscribeCallback"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
-
 Get a callback to subscribe to events on a topic and optionally unsubscribe on unmount.
 
 This is useful to start a subscription from an event handler, like a button click.
@@ -13,6 +11,16 @@ This is useful to start a subscription from an event handler, like a button clic
   Your browser does not support the video tag.
 </video>
 
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
 ## Usage
 
 The following component subscribes to the `backgroundJobs/recompute` topic on click, and displays the progress of the background job:
diff --git a/docs_headless/src/content/docs/useSubscribeToRecord.md b/docs_headless/src/content/docs/useSubscribeToRecord.md
@@ -2,15 +2,23 @@
 title: "useSubscribeToRecord"
 ---
 
-**Tip**: `ra-core-ee` is part of the [React-Admin Enterprise Edition](https://marmelab.com/ra-enterprise/), and hosted in a private npm registry. You need to subscribe to one of the Enterprise Edition plans to access this package.
-
 This specialized version of `useSubscribe` subscribes to events concerning a single record.
 
 <video controls autoplay playsinline muted loop>
   <source src="https://react-admin-ee.marmelab.com/assets/useSubscribeToRecord.mp4" type="video/mp4"/>
   Your browser does not support the video tag.
 </video>
 
+This feature requires a valid [Enterprise Edition](https://marmelab.com/ra-enterprise/) subscription.
+
+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```
+
 ## Usage
 
 The hook expects a callback function as its only argument, as it guesses the record and resource from the current context. The callback will be executed whenever an event is published on the `resource/[resource]/[recordId]` topic.
diff --git a/docs_headless/src/content/docs/useSubscribeToRecordList.md b/docs_headless/src/content/docs/useSubscribeToRecordList.md
diff --git a/docs_headless/src/content/docs/useUnlock.md b/docs_headless/src/content/docs/useUnlock.md
