flatten file structure

Author: slax57

docs_headless/astro.config.mjs

@@ -31,87 +31,163 @@ export default defineConfig({
                 },
                 {
                     label: 'Guides & Concepts',
-                    autogenerate: {
-                        directory: 'guides',
-                    },
+                    items: [
+                        'architecture',
+                        'datafetchingguide',
+                        'crud',
+                        'forms',
+                        'securityguide',
+                        'routing',
+                        'translation',
+                        'store',
+                        'features',
+                    ],
                 },
                 {
                     label: 'App Configuration',
-                    autogenerate: {
-                        directory: 'app-configuration',
-                    },
+                    items: ['coreadmin', 'resource', 'customroutes'],
                 },
                 {
                     label: 'Data Fetching',
-                    autogenerate: {
-                        directory: 'data-fetching',
-                    },
+                    items: [
+                        'dataproviders',
+                        'actions',
+                        'dataproviderlist',
+                        'dataproviderwriting',
+                        'fetchjson',
+                        'usecreate',
+                        'usedataprovider',
+                        'usedelete',
+                        'usedeletemany',
+                        'usegetlist',
+                        'usegetmany',
+                        'usegetmanyreference',
+                        'usegetone',
+                        'useinfinitegetlist',
+                        'useupdate',
+                        'useupdatemany',
+                        'withlifecyclecallbacks',
+                    ],
                 },
                 {
                     label: 'Security',
-                    autogenerate: {
-                        directory: 'security',
-                    },
+                    items: [
+                        'authentication',
+                        'authproviderlist',
+                        'authproviderwriting',
+                        'permissions',
+                        'authenticated',
+                        'canaccess',
+                        'useauthenticated',
+                        'useauthprovider',
+                        'useauthstate',
+                        'usecanaccess',
+                        'usegetidentity',
+                        'uselogin',
+                        'uselogout',
+                        'usepermissions',
+                        'addrefreshauthtoauthprovider',
+                        'addrefreshauthtodataprovider',
+                    ],
                 },
                 {
                     label: 'List Page',
-                    autogenerate: {
-                        directory: 'list',
-                    },
+                    items: [
+                        'listtutorial',
+                        'filteringtutorial',
+                        'listbase',
+                        'infinitelistbase',
+                        'listiterator',
+                        'filterliveform',
+                        'withlistcontext',
+                        'uselist',
+                        'uselistcontext',
+                        'uselistcontroller',
+                        'useunselect',
+                        'useunselectall',
+                    ],
                 },
                 {
                     label: 'Creation & Edition Pages',
-                    autogenerate: {
-                        directory: 'create-edit',
-                    },
+                    items: [
+                        'edittutorial',
+                        'validation',
+                        'createbase',
+                        'editbase',
+                        'form',
+                        'usecreatecontext',
+                        'usecreatecontroller',
+                        'useeditcontext',
+                        'useeditcontroller',
+                        'userecordfromlocation',
+                        'useregistermutationmiddleware',
+                        'usesavecontext',
+                        'useunique',
+                    ],
                 },
                 {
                     label: 'Show Page',
-                    autogenerate: {
-                        directory: 'show',
-                    },
+                    items: ['showbase', 'useshowcontext', 'useshowcontroller'],
                 },
                 {
                     label: 'Common',
-                    autogenerate: {
-                        directory: 'common',
-                    },
+                    items: [
+                        'withrecord',
+                        'usegetrecordid',
+                        'usenotify',
+                        'userecordcontext',
+                        'useredirect',
+                        'userefresh',
+                    ],
                 },
                 {
                     label: 'Fields',
-                    autogenerate: {
-                        directory: 'fields',
-                    },
+                    items: [
+                        'fields',
+                        'fieldsforrelationships',
+                        'referencearrayfieldbase',
+                        'referencefieldbase',
+                        'referencemanycountbase',
+                        'referencemanyfieldbase',
+                        'referenceonefieldbase',
+                        'usefieldvalue',
+                    ],
                 },
                 {
                     label: 'Inputs',
-                    autogenerate: {
-                        directory: 'inputs',
-                    },
+                    items: ['inputs', 'useinput'],
                 },
                 {
                     label: 'Preferences',
-                    autogenerate: {
-                        directory: 'preferences',
-                    },
+                    items: [
+                        'usestore',
+                        'useremovefromstore',
+                        'useresetstore',
+                        'usestorecontext',
+                    ],
                 },
                 {
                     label: 'I18N Provider & Translations',
-                    autogenerate: {
-                        directory: 'i18n',
-                    },
+                    items: [
+                        'translationsetup',
+                        'translationlocales',
+                        'translationtranslating',
+                        'translationwriting',
+                        'translate',
+                        'uselocalestate',
+                        'usetranslate',
+                    ],
                 },
                 {
                     label: 'Other Components & Hooks',
-                    autogenerate: {
-                        directory: 'other',
-                    },
+                    items: [
+                        'recordrepresentation',
+                        'usegetrecordrepresentation',
+                    ],
                 },
                 {
                     label: 'Recipes',
-                    autogenerate: {
-                        directory: 'recipes',
-                    },
+                    items: ['caching', 'unittesting'],
                 },
             ],
             components: {

…rc/content/docs/data-fetching/Actions.md docs_headless/src/content/docs/Actions.mddocs_headless/src/content/docs/data-fetching/Actions.md renamed to docs_headless/src/content/docs/Actions.md docs_headless/src/content/docs/data-fetching/Actions.md renamed to docs_headless/src/content/docs/Actions.md

@@ -310,9 +310,9 @@ To execute some logic after a query or a mutation is complete, use the `onSucces
 
 **Tip**: React-admin provides the various hooks to handle the most common side effects:
 
-- [`useNotify`](../common/useNotify.md): Return a function to display a notification.
-- [`useRedirect`](../common/useRedirect.md): Return a function to redirect the user to another page.
-- [`useRefresh`](../common/useRefresh.md): Return a function to force a rerender of the current view (equivalent to pressing the Refresh button).
+- [`useNotify`](./useNotify.md): Return a function to display a notification.
+- [`useRedirect`](./useRedirect.md): Return a function to redirect the user to another page.
+- [`useRefresh`](./useRefresh.md): Return a function to force a rerender of the current view (equivalent to pressing the Refresh button).
 
 ### `onSuccess`
 

…/src/content/docs/guides/Architecture.md …eadless/src/content/docs/Architecture.mddocs_headless/src/content/docs/guides/Architecture.md renamed to docs_headless/src/content/docs/Architecture.md docs_headless/src/content/docs/guides/Architecture.md renamed to docs_headless/src/content/docs/Architecture.md

@@ -10,11 +10,11 @@ React-admin relies on a several design decisions that structure its codebase.
 
 React-admin is specifically designed to build [Single-Page Applications (SPA)](https://en.wikipedia.org/wiki/Single-page_application). In a react-admin app, the browser fetches the required HTML, CSS, and JavaScript to render the application only once. Subsequently, data is fetched from APIs through AJAX calls. This is in contrast to traditional web applications, where the browser fetches a new HTML page for each screen.
 
-<img class="no-shadow" src="../../img/SPA-lifecycle.png" alt="SPA lifecycle" />
+<img class="no-shadow" src="../img/SPA-lifecycle.png" alt="SPA lifecycle" />
 
 The SPA architecture ensures that react-admin apps are [exceptionally fast](./Features.md#fast), easy to host, and compatible with existing APIs without requiring a dedicated backend. 
 
-To achieve this, react-admin utilizes an internal router, powered by `react-router`, to display the appropriate screen when the user clicks on a link. Developers can define routes using the [`<Resource>`](../app-configuration/Resource.md) component for CRUD routes and the [`<CustomRoutes>`](../app-configuration/CustomRoutes.md) component for other routes.
+To achieve this, react-admin utilizes an internal router, powered by `react-router`, to display the appropriate screen when the user clicks on a link. Developers can define routes using the [`<Resource>`](./Resource.md) component for CRUD routes and the [`<CustomRoutes>`](./CustomRoutes.md) component for other routes.
 
 For example, the following react-admin application:
 
@@ -58,7 +58,7 @@ The `<Resource>` component allows react-admin to automatically link CRUD pages b
 
 React-admin does not make any assumptions about the specific structure of your API. Instead, it defines its own syntax for data fetching, authentication, internationalization, and preferences. To interact with your API, react-admin relies on adapters called **providers**.
 
-<img class="no-shadow" src="../../img/providers.png" alt="Providers" />
+<img class="no-shadow" src="../img/providers.png" alt="Providers" />
 
 For example, to fetch a list of records from the API, you would use the `dataProvider` object as follows:
 
@@ -99,9 +99,9 @@ Content-Range: posts 0-4/27
 ]
 ```
 
-React-admin comes with [more than 50 data providers](../data-fetching/DataProviderList.md) for various backends, including REST, GraphQL, Firebase, Django REST Framework, API Platform, and more. If these providers do not suit your API, you have the flexibility to [develop a custom provider](../data-fetching/DataProviderWriting.md).
+React-admin comes with [more than 50 data providers](./DataProviderList.md) for various backends, including REST, GraphQL, Firebase, Django REST Framework, API Platform, and more. If these providers do not suit your API, you have the flexibility to [develop a custom provider](./DataProviderWriting.md).
 
-This approach is why react-admin components do not call `fetch` or `axios` directly. Instead, they rely on the data provider to fetch data from the API. Similarly, it is recommended that your custom components follow the same pattern and utilize [data provider hooks](../data-fetching/Actions.md), such as [`useGetList`](../data-fetching/useGetList.md):
+This approach is why react-admin components do not call `fetch` or `axios` directly. Instead, they rely on the data provider to fetch data from the API. Similarly, it is recommended that your custom components follow the same pattern and utilize [data provider hooks](./Actions.md), such as [`useGetList`](./useGetList.md):
 
 ```jsx
 import { useGetList } from 'ra-core';

docs_headless/src/content/docs/AuthProviderList.md

@@ -0,0 +1,37 @@
+---
+layout: default
+title: "Supported Auth Provider Backends"
+sidebar:
+  order: 2
+  label: Supported Backends
+---
+
+It's very common that your auth logic is so specific that you'll need to write your own `authProvider`. However, the community has built a few open-source Auth Providers that may fit your need:
+
+<div class="providers-list" markdown="1">
+
+- ![Appwrite Logo](../../img/backend-logos/appwrite.svg "Appwrite Logo")**[Appwrite](https://appwrite.io/)**: [marmelab/ra-appwrite](https://github.com/marmelab/ra-appwrite)
+- ![auth0 Logo](../../img/backend-logos/auth0.svg "auth0 Logo")**[Auth0 by Okta](https://auth0.com/)**: [marmelab/ra-auth-auth0](https://github.com/marmelab/ra-auth-auth0/blob/main/packages/ra-auth-auth0/Readme.md)
+- ![amplify Logo](../../img/backend-logos/amplify.svg "amplify Logo")**[AWS Amplify](https://docs.amplify.aws)**: [MrHertal/react-admin-amplify](https://github.com/MrHertal/react-admin-amplify)
+- ![cognito Logo](../../img/backend-logos/aws.png "cognito Logo")**[AWS Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/setting-up-the-javascript-sdk.html)**: [marmelab/ra-auth-cognito](https://github.com/marmelab/ra-auth-cognito/blob/main/packages/ra-auth-cognito/Readme.md)
+- ![azure Logo](../../img/backend-logos/microsoft.svg "azure Logo")**[Microsoft Entra ID (using MSAL)](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-browser)**: [marmelab/ra-auth-msal](https://github.com/marmelab/ra-auth-msal/blob/main/packages/ra-auth-msal/Readme.md) ([Tutorial](https://marmelab.com/blog/2023/09/13/active-directory-integration-tutorial.html))
+- ![casdoor Logo](../../img/backend-logos/casdoor.svg "casdoor Logo")**[Casdoor](https://casdoor.com/)**: [NMB-Lab/reactadmin-casdoor-authprovider](https://github.com/NMB-Lab/reactadmin-casdoor-authprovider)
+- ![directus Logo](../../img/backend-logos/directus.svg "directus Logo")**[Directus](https://directus.io/)**: [marmelab/ra-directus](https://github.com/marmelab/ra-directus/blob/main/packages/ra-directus/Readme.md)
+- ![firebase Logo](../../img/backend-logos/firebase.png "firebase Logo")**[Firebase Auth (Google, Facebook, GitHub, etc.)](https://firebase.google.com/docs/auth/web/firebaseui)**: [benwinding/react-admin-firebase](https://github.com/benwinding/react-admin-firebase#auth-provider)
+- ![google Logo](../../img/backend-logos/google.svg "google Logo")**[Google Identity & Google Workspace](https://developers.google.com/identity/gsi/web/guides/overview)**: [marmelab/ra-auth-google](https://github.com/marmelab/ra-auth-google/blob/main/packages/ra-auth-google/Readme.md)
+- ![keycloak Logo](../../img/backend-logos/keycloak.svg "keycloak Logo")**[Keycloak](https://www.keycloak.org/)**: [marmelab/ra-keycloak](https://github.com/marmelab/ra-keycloak/blob/main/packages/ra-keycloak/Readme.md)
+- ![supabase Logo](../../img/backend-logos/supabase.svg "supabase Logo")**[Supabase](https://supabase.io/)**: [marmelab/ra-supabase](https://github.com/marmelab/ra-supabase/blob/main/packages/ra-supabase/README.md)
+- ![surrealdb Logo](../../img/backend-logos/surrealdb.svg "surrealdb Logo")**[SurrealDB](https://surrealdb.com/)**: [djedi23/ra-surrealdb](https://github.com/djedi23/ra-surrealdb)
+
+</div>
+
+Beyond ready-to-use providers, you may find help in these third-party tutorials about integrating more authentication backends:
+
+<div class="providers-list" markdown="1">
+
+- ![loopback Logo](../../img/backend-logos/loopback4.svg "loopback Logo")**[Loopback](https://loopback.io/doc/en/lb4/Authentication-overview.html)**: [appsmith dev.to tutorial](https://dev.to/appsmith/building-an-admin-dashboard-with-react-admin-86i#adding-authentication-to-reactadmin)
+- ![openid Logo](../../img/backend-logos/openid.svg "openid Logo")**[OpenID Connect (OIDC)](https://openid.net/connect/)**: [marmelab/ra-example-oauth](https://github.com/marmelab/ra-example-oauth)
+
+</div>
+
+If you have released a reusable `authProvider`, or a tutorial for another auth backend, please open a PR to add it to this list!