Merge pull request #12823 from KratosMultiphysics/particle/update_readme

[MPM] Update README file
KratosMultiphysics · Nov 7, 2024 · 8bad3b0 · 8bad3b0
2 parents f4d5f6d + e0b7639
commit 8bad3b0
Show file tree

Hide file tree

Showing 8 changed files with 142 additions and 288 deletions.
diff --git a/applications/MPMApplication/README.md b/applications/MPMApplication/README.md
diff --git a/docs/pages/Applications/MPM_Application/Examples/Cylinder_on_inclined_plane.md b/docs/pages/Applications/MPM_Application/Examples/Cylinder_on_inclined_plane.md
diff --git a/docs/pages/Applications/MPM_Application/Examples/Granular_flow_2d.md b/docs/pages/Applications/MPM_Application/Examples/Granular_flow_2d.md
diff --git a/docs/pages/Applications/MPM_Application/Examples/menu_info.json b/docs/pages/Applications/MPM_Application/Examples/menu_info.json
@@ -0,0 +1,16 @@
+{
+    "custom_entries": [
+        {
+            "type": "kratos_example",
+            "raw_url": "https://raw.githubusercontent.com/KratosMultiphysics/Examples/refs/heads/master/mpm/validation/cylinder_on_inclined_plane/README.md",
+            "source_url": "https://github.com/KratosMultiphysics/Examples/tree/master/mpm/validation/cylinder_on_inclined_plane",
+            "file_name": "Cylinder_on_inclined_plane_2D.md"
+        },
+        {
+            "type": "kratos_example",
+            "raw_url": "https://raw.githubusercontent.com/KratosMultiphysics/Examples/refs/heads/master/mpm/validation/granular_flow_2D/README.md",
+            "source_url": "https://github.com/KratosMultiphysics/Examples/tree/master/mpm/validation/granular_flow_2D",
+            "file_name": "Granular_Flow_2D.md"
+        }
+    ]
+}
diff --git a/docs/pages/Applications/MPM_Application/General/Overview.md b/docs/pages/Applications/MPM_Application/General/Overview.md
diff --git a/docs/pages/Applications/MPM_Application/General/menu_info.json b/docs/pages/Applications/MPM_Application/General/menu_info.json
@@ -0,0 +1,10 @@
+{
+    "custom_entries": [
+        {
+            "type": "kratos_example",
+            "raw_url": "https://raw.githubusercontent.com/KratosMultiphysics/Kratos/refs/heads/particle/update_readme/applications/MPMApplication/README.md",
+            "source_url": "https://github.com/KratosMultiphysics/Kratos/tree/particle/update_readme/applications/MPMApplication",
+            "file_name": "Overview.md"
+        }
+    ]
+}
diff --git a/docs/pages/Applications/MPM_Application/General/remote_Overview.md b/docs/pages/Applications/MPM_Application/General/remote_Overview.md
@@ -0,0 +1,8 @@
+---
+title: MPM Application
+keywords: 
+tags: [remote_Overview.md]
+sidebar: mpm_application
+summary: 
+---
+
diff --git a/docs/pages/Applications/MPM_Application/menu_info.json b/docs/pages/Applications/MPM_Application/menu_info.json
@@ -1,6 +1,6 @@
 {
     "side_bar_name": "mpm_application",
-    "landing_page": "General/Overview.md",
+    "landing_page": "General/remote_Overview.md",
     "additional_menu_options": {
         "product": "MPM Application",
         "title": "sidebar"