docs: update 8.2 to new format (#781)

* RM#86101
axelor · Oct 29, 2024 · 4a99a44 · 4a99a44
1 parent 797d7f6
commit 4a99a44
Show file tree

Hide file tree

Showing 48 changed files with 96 additions and 124 deletions.
diff --git a/docs/doc/en/Application/Creation_d_un_ecran.md b/docs/doc/en/Application/Creation_d_un_ecran.md
@@ -1,7 +1,6 @@
 ---
-id: Création d’un écran
 sidebar_position: 3
-sidebar_class_name: icon
+description: ''
 ---
 
 # Screen creation

diff --git a/docs/doc/en/Application/Creation_d_un_menu.md b/docs/doc/en/Application/Creation_d_un_menu.md
@@ -1,10 +1,9 @@
 ---
-id: Création d’un menu
 sidebar_position: 4
-sidebar_class_name: icon
+description: ''
 ---
 
-## Creating a menu
+# Creating a menu
 
 The definition of a menu requires the definition of a screen to be displayed when the user selects the menu entry in the drawer.
 

diff --git a/docs/doc/en/Application/Creation_d_un_module.md b/docs/doc/en/Application/Creation_d_un_module.md
@@ -1,10 +1,9 @@
 ---
-id: Création d’un module
 sidebar_position: 5
-sidebar_class_name: icon
+description: ''
 ---
 
-## Creating a module
+# Creating a module
 
 The application uses a module structure. Each functional package must export an object in the _Module_ format defined in the **CORE** package.
 

diff --git a/docs/doc/en/Application/Creations_d_un_appel_API.md b/docs/doc/en/Application/Creations_d_un_appel_API.md
@@ -1,7 +1,6 @@
 ---
-id: Création d’un appel API
 sidebar_position: 2
-sidebar_class_name: icon
+description: ''
 ---
 
 # Creating an API call

diff --git a/docs/doc/en/Application/Gestion_des_composants.md b/docs/doc/en/Application/Gestion_des_composants.md
@@ -1,7 +1,6 @@
 ---
-id: Gestion des composants
 sidebar_position: 1
-sidebar_class_name: icon
+description: ''
 ---
 
 # Component management
@@ -61,7 +60,7 @@ axelor-mobile/
 
 Once in the stories folder, components are sorted by type (atoms, molecules, organisms & templates) in the same way as in the package sources.
 
-A story is a component use case. In the storybook, you need to successfully re-create all the component's use cases to enable better documentation. To create a story, you need to create a new file in the _stories_ folder, in the right component category. The nomenclature for the file name is _<component name>.stories.tsx_.
+A story is a component use case. In the storybook, you need to successfully re-create all the component's use cases to enable better documentation. To create a story, you need to create a new file in the _stories_ folder, in the right component category. The nomenclature for the file name is `<component name>.stories.tsx`.
 
 There can then be two types of stories: fixed stories in the style of a catalog, or customizable stories where the user can modify each attribute to make the combinations of his choice.
 

diff --git a/docs/doc/en/Application/Index.md b/docs/doc/en/Application/Index.md
diff --git a/docs/doc/en/Application/_category_.json b/docs/doc/en/Application/_category_.json
@@ -0,0 +1,8 @@
+{
+  "className": "cloud-fill",
+  "label": "Creating your own app",
+  "position": 5,
+  "link": {
+    "type": "generated-index"
+  }
+}
diff --git a/docs/doc/en/Application/buildCustomization.md b/docs/doc/en/Application/buildCustomization.md
@@ -1,22 +1,23 @@
 ---
-id: buildCustomization
 sidebar_position: 6
-sidebar_class_name: icon
+description: ''
 ---
 
-# Android build customization
+# Build customization
 
-## Name modification
+## Android
+
+### Name modification
 
 To modify the name displayed under the application once installed, you need to modify the value associated with the _app_name_ key in the `android > app > src > main > res > values > strings.xml` file.
 
-## Changing the identifier
+### Changing the identifier
 
 To create an application distinct from Axelor Mobile, you need to modify the package name associated with the application in the native Android code. There's no easy way to do this. You need to perform a global search in the Android folder and replace all occurrences of the standard package name _com.aosmobile_, with and without capital letters, with the name of the new package. You should also remember to modify the structure of the _java_ folders in the main and debug sections to adapt to the new package name.
 
 The last step is to modify the package name at the root of the project, as well as the version, and to modify the identifier used by Metro in the `app.json` file to use the identifier of the new application.
 
-## Modifying the application icon
+### Modifying the application icon
 
 To modify the application icon, open the application's Android folder in **Android Studio**. The project may take some time to initialize. Once the IDE is ready, create a new _Image Asset_ in the resources folder.
 
@@ -28,13 +29,13 @@ Next, you need to provide the path to the image to be used for generation. It's
 
 Then simply validate the configuration and Android Studio will generate all the icon sizes and shapes for the application.
 
-# iOS build customization
+## iOS
 
-## Name and ID modification
+### Name and ID modification
 
 To change the name or identifier of an iOS application, use XCode and open the application's General tab. In the _identity_ panel, modify the _Display Name_ and/or _Bundle Identifier_ with the desired values. The changes should then appear in the `Info.plist` and `project.pbxproj` files.
 
-## Application icon modification
+### Application icon modification
 
 To modify the application icon, open the application's ios folder in **Xcode**. The project may take some time to initialize. Once the IDE is ready, modify the AppIcon file in `AosMobile > Images`. To only have to load a single image, select _Single Size_ in the right sidebar.
 

diff --git a/docs/doc/en/Architecture.md b/docs/doc/en/Architecture.md
@@ -1,7 +1,6 @@
 ---
-id: Architecture de l'application
 sidebar_position: 3
-sidebar_class_name: icon architecture
+description: ''
 ---
 
 # Application architecture

diff --git a/docs/doc/en/GettingStarted.md b/docs/doc/en/GettingStarted.md
@@ -1,7 +1,6 @@
 ---
-id: Getting Started
 sidebar_position: 2
-sidebar_class_name: icon started
+description: ''
 ---
 
 # Getting started

diff --git a/docs/doc/en/Introduction.md b/docs/doc/en/Introduction.md
@@ -1,9 +1,7 @@
 ---
-id: Introduction
 slug: /
 sidebar_position: 1
-sidebar_label: Introduction
-sidebar_class_name: icon introduction
+description: ''
 ---
 
 # Introduction

diff --git a/docs/doc/en/Outil/Gestion_des_headers.md b/docs/doc/en/Outil/Gestion_des_headers.md
@@ -1,7 +1,6 @@
 ---
-id: Gestions des headers
 sidebar_position: 6
-sidebar_class_name: icon gestions des headers
+description: ''
 ---
 
 # Header management
@@ -31,7 +30,7 @@ const useCustomerDeliveryDetailsActions = () => {
 
 The `headerActionsProvider` tool must therefore be used to associate a key with an object containing all the information required for the various header actions.
 
-A nomenclature has been set up to help understand the origin of a key: _<Module><Object><Screen type>._.
+A nomenclature has been set up to help understand the origin of a key: `<Module><Object><Screen type>`.
 
 Actions are defined through a structure named `HeaderOptions` :
 

diff --git a/docs/doc/en/Outil/Gestion_du_theme.md b/docs/doc/en/Outil/Gestion_du_theme.md
@@ -1,7 +1,6 @@
 ---
-id: Themes
 sidebar_position: 2
-sidebar_class_name: icon themes
+description: ''
 ---
 
 # Theme management

diff --git a/docs/doc/en/Outil/Gestions_de_camera.md b/docs/doc/en/Outil/Gestions_de_camera.md
@@ -1,7 +1,6 @@
 ---
-id: Gestion de la camera
 sidebar_position: 8
-sidebar_class_name: icon gestion de la camera
+description: ''
 ---
 
 # Using the camera and/or scanner

diff --git a/docs/doc/en/Outil/Gestions_de_traductions.md b/docs/doc/en/Outil/Gestions_de_traductions.md
@@ -1,7 +1,6 @@
 ---
-id: Traductions
 sidebar_position: 1
-sidebar_class_name: icon  traductions
+description: ''
 ---
 
 # Translation management
@@ -14,7 +13,7 @@ Each module must include in its architecture an i18n folder with json files, one
 
 Within the translation files, the keys must follow a nomenclature in order to structure all translations and identify their origin.
 
-The nomenclature is as follows: _<Module>\_<Signification>_.
+The nomenclature is as follows: `<Module>\_<Signification>`.
 
 All translation keys must be written in **English** to enable the user to continue using the application even if the translation value has not been found.
 

diff --git a/docs/doc/en/Outil/Gestions_des_API_providers.md b/docs/doc/en/Outil/Gestions_des_API_providers.md
@@ -1,7 +1,6 @@
 ---
-id: API providers
 sidebar_position: 4
-sidebar_class_name: icon API providers
+description: ''
 ---
 
 # API provider management

diff --git a/docs/doc/en/Outil/_category_.json b/docs/doc/en/Outil/_category_.json
@@ -0,0 +1,8 @@
+{
+  "className": "tools",
+  "label": "Tools at your disposal",
+  "position": 4,
+  "link": {
+    "type": "generated-index"
+  }
+}
diff --git a/docs/doc/en/Outil/gestion_des_erreurs.md b/docs/doc/en/Outil/gestion_des_erreurs.md
@@ -1,7 +1,6 @@
 ---
-id: Gestions des erreurs
 sidebar_position: 3
-sidebar_class_name: icon gestions des erreurs
+description: ''
 ---
 
 # Error handling

diff --git a/docs/doc/en/Outil/gestions_de_store.md b/docs/doc/en/Outil/gestions_de_store.md
@@ -1,7 +1,6 @@
 ---
-id: Gestion de store
 sidebar_position: 5
-sidebar_class_name: icon gestion de store
+description: ''
 ---
 
 # Store management
@@ -44,7 +43,7 @@ export const handlerApiCall = ({
 }: ApiHandlerProps)
 ```
 
-When creating the asynchronous function, it's important to respect the following nomenclature for creating the type: _<slice name>/<function name>._ There is also a nomenclature for creating the translation keys used to describe the action executed: _"<module name>SliceAction<action>"_. In addition, to make translation files easier to read, translations for reducer actions are grouped together at the end of the files.
+When creating the asynchronous function, it's important to respect the following nomenclature for creating the type: `<slice name>/<function name>`. There is also a nomenclature for creating the translation keys used to describe the action executed: `<module name>SliceAction<action>`. In addition, to make translation files easier to read, translations for reducer actions are grouped together at the end of the files.
 
 Next, we need to build a slice to indicate the behavior to be adopted in the various query states (pending, rejected or fulfilled). In order to access the store state for this slice, it must be exported, then the reducer created must be exported so that it can be added to the module export.
 

diff --git a/docs/doc/en/Outil/index.md b/docs/doc/en/Outil/index.md
diff --git a/docs/doc/en/Outil/permissionManagement.md b/docs/doc/en/Outil/permissionManagement.md
@@ -1,7 +1,6 @@
 ---
-id: permissionManagement
 sidebar_position: 9
-sidebar_class_name: icon permissions
+description: ''
 ---
 
 # Permission management

diff --git a/docs/doc/en/Outil/selectionManagement.md b/docs/doc/en/Outil/selectionManagement.md
@@ -1,7 +1,6 @@
 ---
-id: selectionManagement
 sidebar_position: 7
-sidebar_class_name: icon selections
+description: ''
 ---
 
 # Selections management

diff --git a/docs/doc/en/Outil/toolManagenent.md b/docs/doc/en/Outil/toolManagenent.md
@@ -1,7 +1,6 @@
 ---
-id: toolManagement
 sidebar_position: 10
-sidebar_class_name: icon tools
+description: ''
 ---
 
 # Quick actions management

diff --git a/docs/doc/en/pratique.md b/docs/doc/en/pratique.md
@@ -1,7 +1,6 @@
 ---
-id: Bonnes pratiques de dévleloppement
 sidebar_position: 6
-sidebar_class_name: icon pratique
+description: ''
 ---
 
 # Good development practices

diff --git a/docs/doc/fr/Application/Creation_d_un_ecran.md b/docs/doc/fr/Application/Creation_d_un_ecran.md
@@ -1,7 +1,6 @@
 ---
-id: Création d’un écran
 sidebar_position: 3
-sidebar_class_name: icon
+description: ''
 ---
 
 # Création d’un écran

diff --git a/docs/doc/fr/Application/Creation_d_un_menu.md b/docs/doc/fr/Application/Creation_d_un_menu.md
@@ -1,7 +1,6 @@
 ---
-id: Création d’un menu
 sidebar_position: 4
-sidebar_class_name: icon
+description: ''
 ---
 
 # Création d’un menu

diff --git a/docs/doc/fr/Application/Creation_d_un_module.md b/docs/doc/fr/Application/Creation_d_un_module.md
@@ -1,7 +1,6 @@
 ---
-id: Création d’un module
 sidebar_position: 5
-sidebar_class_name: icon
+description: ''
 ---
 
 # Création d’un module

diff --git a/docs/doc/fr/Application/Creations_d_un_appel_API.md b/docs/doc/fr/Application/Creations_d_un_appel_API.md
@@ -1,7 +1,6 @@
 ---
-id: Création d’un appel API
 sidebar_position: 2
-sidebar_class_name: icon
+description: ''
 ---
 
 # Création d’un appel API

diff --git a/docs/doc/fr/Application/Gestion_des_composants.md b/docs/doc/fr/Application/Gestion_des_composants.md
@@ -1,7 +1,6 @@
 ---
-id: Gestion des composants
 sidebar_position: 1
-sidebar_class_name: icon
+description: ''
 ---
 
 # Gestion des composants

diff --git a/docs/doc/fr/Application/Index.md b/docs/doc/fr/Application/Index.md
diff --git a/docs/doc/fr/Application/_category_.json b/docs/doc/fr/Application/_category_.json
@@ -0,0 +1,8 @@
+{
+  "className": "cloud-fill",
+  "label": "Création de votre propre application",
+  "position": 5,
+  "link": {
+    "type": "generated-index"
+  }
+}