[Doc] Add documentation for headless enterprise features in ra-core documentation #10973

djhi · 2025-09-29T10:26:54Z

Problem

We now have headless support for some React Admin Enterprise features. It's time to mention them in the ra-core documentation.

How To Test

make doc-headless

Additional Checks

The PR targets master for a bugfix or a documentation fix, or next for a feature

Screenshots

…tation

slax57 · 2025-10-01T14:58:30Z

docs_headless/astro.config.mjs

+ */
+function enterpriseEntry(name) {
+    return {
+        link: name.toLowerCase().replace(/</g, '').replace(/>/g, ''),


Suggested change

link: name.toLowerCase().replace(/</g, '').replace(/>/g, ''),

link: name.toLowerCase().replace(/</g, '').replace(/>/g, '') + '/',

Links need to end up with a trailing slash, otherwise the (local) assets path are messed up

slax57 · 2025-10-01T14:58:54Z

docs_headless/src/content/docs/LockStatusBase.md

+};
+```
+
+In addition to the [`useLockCallbacks`](#uselockcallbacks) parameters, `<LockStatusBase>` accepts a `render` prop. The function passed to the `render` prop will be called with the result of the `useLockCallbacks` hook.


slax57 · 2025-10-01T14:59:39Z

docs_headless/src/content/docs/canAccessWithPermissions.md

+| `resource` | Required | `string` | The resource for which to check users has the execution right
+| `record` | Required | `string` | The record for which to check users has the execution right
+
+`canAccessWithPermissions` expects the `permissions` to be a flat array of permissions. It is your responsibility to fetch these permissions (usually during login). If the permissions are spread into several role definitions, you can merge them into a single array using the [`getPermissionsFromRoles`](#getpermissionsfromroles) function.


dead link

probably many others like this in this whole PR, I won't point them all...

slax57 · 2025-10-01T15:01:10Z

docs_headless/astro.config.mjs

+        badge: {
+            text: 'React Admin Enterprise',
+            variant: 'default',
+        },


Is the badge used somewhere? I don't see it... 🤔

UPDATE: or is it for a11y?

a11y indeed

slax57 · 2025-10-01T15:13:14Z

docs_headless/src/content/docs/useGetListLive.md

+
+The hook will subscribe to live updates on the list of records (topic: `resource/[resource]`) and will refetch the list when a new record is created, or an existing record is updated or deleted.
+
+See the [useGetList](https://marmelab.com/react-admin/useGetList.html) documentation for the full list of parameters and return type.


should link to ra-core docs

slax57 · 2025-10-01T15:13:38Z

docs_headless/src/content/docs/useGetOneLive.md

+
+The hook will subscribe to live updates on the record (topic: `resource/[resource]/[id]`) and will refetch the record when it is updated or deleted.
+
+See the [useGetOne](https://marmelab.com/react-admin/useGetOne.html) documentation for the full list of parameters and return type.


Copilot

Pull Request Overview

This PR adds documentation for headless React Admin Enterprise features to the ra-core documentation. It introduces comprehensive documentation for enterprise features like real-time subscriptions, record locking, and role-based permissions in a headless context.

Adds documentation for 20+ enterprise hooks and utilities including real-time subscriptions, record locking, and permission management
Updates the documentation site configuration to include a new "Realtime" section with enterprise-specific styling
Adds CSS styling for enterprise features with premium badges and theme-aware icons

Reviewed Changes

Copilot reviewed 21 out of 23 changed files in this pull request and generated 5 comments.

File	Description
docs_headless/src/styles/global.css	Adds CSS styling for enterprise links with premium badges and theme-aware icons
docs_headless/astro.config.mjs	Adds new "Realtime" section and enterprise entry helper function for documentation navigation
Multiple .md files	Comprehensive documentation for enterprise hooks covering real-time subscriptions, record locking, permissions, and live data fetching

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-01T15:16:29Z

docs_headless/src/content/docs/useSubscribeToRecordList.md

+    const notity = useNotify();
+    const { refetch, data } = useListContext();
+    useSubscribeToRecordList(event => {
+        switch (event.type) {
+            case 'created': {
+                notity('New movie created');
+                refetch();
+                break;
+            }
+            case 'updated': {
+                if (data.find(record => record.id === event.payload.ids[0])) {
+                    notity(`Movie #${event.payload.ids[0]} updated`);
+                    refetch();
+                }
+                break;
+            }
+            case 'deleted': {
+                if (data.find(record => record.id === event.payload.ids[0])) {
+                    notity(`Movie #${event.payload.ids[0]} deleted`);


Typo in variable name: 'notity' should be 'notify'.

Suggested change

const notity = useNotify();

const { refetch, data } = useListContext();

useSubscribeToRecordList(event => {

switch (event.type) {

case 'created': {

notity('New movie created');

refetch();

break;

}

case 'updated': {

if (data.find(record => record.id === event.payload.ids[0])) {

notity(`Movie #${event.payload.ids[0]} updated`);

refetch();

}

break;

}

case 'deleted': {

if (data.find(record => record.id === event.payload.ids[0])) {

notity(`Movie #${event.payload.ids[0]} deleted`);

const notify = useNotify();

const { refetch, data } = useListContext();

useSubscribeToRecordList(event => {

switch (event.type) {

case 'created': {

notify('New movie created');

refetch();

break;

}

case 'updated': {

if (data.find(record => record.id === event.payload.ids[0])) {

notify(`Movie #${event.payload.ids[0]} updated`);

refetch();

}

break;

}

case 'deleted': {

if (data.find(record => record.id === event.payload.ids[0])) {

notify(`Movie #${event.payload.ids[0]} deleted`);

Copilot · 2025-10-01T15:16:30Z

docs_headless/src/content/docs/useSubscribeToRecordList.md

+    const notity = useNotify();
+    const { refetch, data } = useListContext();
+    useSubscribeToRecordList(event => {
+        switch (event.type) {
+            case 'created': {
+                notity('New movie created');
+                refetch();
+                break;
+            }
+            case 'updated': {
+                if (data.find(record => record.id === event.payload.ids[0])) {
+                    notity(`Movie #${event.payload.ids[0]} updated`);
+                    refetch();
+                }
+                break;
+            }
+            case 'deleted': {
+                if (data.find(record => record.id === event.payload.ids[0])) {
+                    notity(`Movie #${event.payload.ids[0]} deleted`);


Typo in variable name: 'notity' should be 'notify'.

Suggested change

const notity = useNotify();

const { refetch, data } = useListContext();

useSubscribeToRecordList(event => {

switch (event.type) {

case 'created': {

notity('New movie created');

refetch();

break;

}

case 'updated': {

if (data.find(record => record.id === event.payload.ids[0])) {

notity(`Movie #${event.payload.ids[0]} updated`);

refetch();

}

break;

}

case 'deleted': {

if (data.find(record => record.id === event.payload.ids[0])) {

notity(`Movie #${event.payload.ids[0]} deleted`);

const notify = useNotify();

const { refetch, data } = useListContext();

useSubscribeToRecordList(event => {

switch (event.type) {

case 'created': {

notify('New movie created');

refetch();

break;

}

case 'updated': {

if (data.find(record => record.id === event.payload.ids[0])) {

notify(`Movie #${event.payload.ids[0]} updated`);

refetch();

}

break;

}

case 'deleted': {

if (data.find(record => record.id === event.payload.ids[0])) {

notify(`Movie #${event.payload.ids[0]} deleted`);

Copilot · 2025-10-01T15:16:30Z

docs_headless/src/content/docs/useGetLock.md

+            <button type="submit" disabled={isLockedByOtherUser}>Save</button>
+            {isLockedByOtherUser && (
+                <span>
+                    {`This record is locked by another user: ${lock?.dentity}.`}


Typo in property access: 'dentity' should be 'identity'.

Suggested change

{`This record is locked by another user: ${lock?.dentity}.`}

{`This record is locked by another user: ${lock?.identity}.`}

docs_headless/src/content/docs/getPermissionsFromRoles.md

docs_headless/src/content/docs/canAccessWithPermissions.md

slax57 · 2025-10-02T07:22:30Z

docs_headless/src/content/docs/canAccessWithPermissions.md

+## Installation
+
+```bash
+npm install --save @react-admin/ra-core-ee
+# or
+yarn add @react-admin/ra-core-ee
+```


Didn't we say we kept that only for the EE docs? 🤔

I changed my mind! In its previous form, the doc was not easily comprehensible. We need to make usage more obvious, including installation.

slax57 · 2025-10-02T07:24:09Z

docs_headless/src/content/docs/canAccessWithPermissions.md

+| `resource` | Required | `string` | The resource for which to check users has the execution right
+| `record` | Required | `string` | The record for which to check users has the execution right
+
+`canAccessWithPermissions` expects the `permissions` to be a flat array of permissions. It is your responsibility to fetch these permissions (usually during login). If the permissions are spread into several role definitions, you can merge them into a single array using the [`getPermissionsFromRoles`](#getpermissionsfromroles) function.


Link should target ./getPermissionsFromRoles.md (can't make a Github diff for some reason 🤷 )

Add documentation for headless enterprise features in ra-core documen…

8c7c847

…tation

djhi added the RFR Ready For Review label Sep 29, 2025

vercel bot deployed to Preview – react-admin-storybook September 29, 2025 10:28 View deployment

djhi changed the title ~~Add documentation for headless enterprise features in ra-core documentation~~ [Doc] Add documentation for headless enterprise features in ra-core documentation Sep 29, 2025

slax57 self-requested a review October 1, 2025 14:51

slax57 requested changes Oct 1, 2025

View reviewed changes

slax57 requested a review from Copilot October 1, 2025 15:15

Copilot AI reviewed Oct 1, 2025

View reviewed changes

Improve aces control documentation

a41f301

vercel bot deployed to Preview – react-admin-storybook October 1, 2025 16:52 View deployment

Fix syntax

9f9b365

vercel bot deployed to Preview – react-admin-storybook October 1, 2025 16:56 View deployment

slax57 reviewed Oct 2, 2025

View reviewed changes

Apply review suggestions

147ac5b

vercel bot deployed to Preview – react-admin-storybook October 2, 2025 15:38 View deployment

	link: name.toLowerCase().replace(/</g, '').replace(/>/g, ''),
	link: name.toLowerCase().replace(/</g, '').replace(/>/g, '') + '/',


		The hook will subscribe to live updates on the list of records (topic: `resource/[resource]`) and will refetch the list when a new record is created, or an existing record is updated or deleted.

		See the [useGetList](https://marmelab.com/react-admin/useGetList.html) documentation for the full list of parameters and return type. No newline at end of file


		The hook will subscribe to live updates on the record (topic: `resource/[resource]/[id]`) and will refetch the record when it is updated or deleted.

		See the [useGetOne](https://marmelab.com/react-admin/useGetOne.html) documentation for the full list of parameters and return type. No newline at end of file

	{`This record is locked by another user: ${lock?.dentity}.`}
	{`This record is locked by another user: ${lock?.identity}.`}

Uh oh!

[Doc] Add documentation for headless enterprise features in ra-core documentation #10973

Are you sure you want to change the base?

[Doc] Add documentation for headless enterprise features in ra-core documentation #10973

Uh oh!

Conversation

djhi commented Sep 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

How To Test

Additional Checks

Screenshots

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

djhi commented Sep 29, 2025 •

edited

Loading