[chore]: content-formatting-examples directory restructure

content/content-formatting-examples/academy-theme/csvtable-roles.md → content/content-formatting-examples/academy-theme/csvtable-roles/_index.md

@@ -13,7 +13,3 @@ The `csvtable-roles` shortcode reads `static/data/csv/keys-backup.csv` and rende
 ```
 
 The CSV file must be located at `static/data/csv/keys-backup.csv` with the same format used by `csvtable`.
-
-**Example:**
-
-{{< csvtable-roles >}}

content/content-formatting-examples/academy-theme/csvtable.md → content/content-formatting-examples/academy-theme/csvtable/_index.md

@@ -13,7 +13,3 @@ The `csvtable` shortcode reads `static/data/csv/keys-backup.csv` and renders a p
 ```
 
 The CSV file must be located at `static/data/csv/keys-backup.csv` and contain columns for Category, Function, Feature, and various role names.
-
-**Example:**
-
-{{< csvtable >}}

content/content-formatting-examples/academy-theme/csvtable/keys-backup.csv

@@ -0,0 +1,10 @@
+Category,Function,Feature,Workspace Admin,Workspace Editor,Team Admin,Team Editor,Org Admin,Org Editor,Provider Admin,Keychain ID,Key ID,Inserted,Local Provider
+Designs,Design,Create and edit cloud native designs,X,X,X,X,X,X,X,KC001,K001,2024-01-01,true
+Designs,Design,Delete designs,X,,X,,X,,X,KC001,K002,2024-01-01,true
+Designs,Design,Share designs with team,X,X,X,X,X,X,X,KC001,K003,2024-01-01,true
+Environments,Environment,Create environments,X,X,X,,X,,X,KC002,K004,2024-01-15,true
+Environments,Environment,Delete environments,X,,X,,X,,X,KC002,K005,2024-01-15,true
+Environments,Environment,View environment details,X,X,X,X,X,X,X,KC002,K006,2024-01-15,true
+Connections,Connection,Register connections,X,,X,,X,,X,KC003,K007,2024-02-01,true
+Connections,Connection,Test connections,X,X,X,X,X,X,X,KC003,K008,2024-02-01,true
+Connections,Connection,Delete connections,X,,X,,X,,X,KC003,K009,2024-02-01,true

content/content-formatting-examples/academy-theme/image/_index.md

@@ -0,0 +1,15 @@
+---
+title: Image
+linkTitle: Image
+weight: 6
+description: Render the academy-theme image shortcode.
+draft: true
+---
+
+```text
+{{</* image src="exoscale-icon.png" alt="Alt text" title="Title" width="140px" radius="12%" */>}}
+```
+
+**Example:**
+
+{{< image src="exoscale-icon.png" alt="Exoscale icon displayed with the academy-theme image shortcode" title="Theme image shortcode" width="140px" radius="12%" >}}

content/content-formatting-examples/academy-theme/meshery-design-embed/index.md → content/content-formatting-examples/academy-theme/meshery-design-embed/_index.md

@@ -17,9 +17,12 @@ The `meshery-design-embed` shortcode renders an interactive Meshery design diagr
 
 The rendered output is shown below:
 
+**Example:**
+
 {{< meshery-design-embed
   id="embedded-design-c811e9f4-2522-4eb6-b775-7475545356d8"
   src="./embedded-design-deploy-meshery-using-meshery.js"
 >}}
 
-[Learn more](https://docs.layer5.io/kanvas/designer/embedding-designs/) about embedded designs.
+
+> [Learn more](https://docs.layer5.io/kanvas/designer/embedding-designs/) about embedded designs.

content/content-formatting-examples/academy-theme/svg.md → content/content-formatting-examples/academy-theme/svg/_index.md

@@ -20,6 +20,6 @@ The `svg` shortcode renders an inline SVG icon from `assets/icons/{name}.svg`.
 
 **Example:**
 
-The icon renders inline: {{< svg name="exoscale-icon" >}}
+<!-- The icon renders inline: {{< svg name="exoscale-icon" >}} -->
 
 To add your own SVG icons, place `.svg` files in the `assets/icons/` directory.

content/content-formatting-examples/academy-theme/usestatic.md → content/content-formatting-examples/academy-theme/usestatic/_index.md

@@ -9,7 +9,7 @@ draft: true
 The `usestatic` shortcode resolves a tenant-scoped static file path, prefixing it with the organization UUID configured in `params.defined_org`.
 
 ```text
-{{</* usestatic "images/exoscale-icon.png" */>}}
+{{</* usestatic "exoscale-icon.png" */>}}
 ```
 
-Resolved tenant-scoped static path: {{< usestatic "images/exoscale-icon.png" >}}
+Resolved tenant-scoped static path: {{< usestatic "./exoscale-icon.png" >}}

content/content-formatting-examples/docsy/iframe/_index.md

@@ -0,0 +1,15 @@
+---
+title: Iframe
+linkTitle: Iframe
+weight: 8
+description: Render the Docsy iframe shortcode.
+draft: true
+---
+
+```text
+{{</* iframe src="frame-example.html" style="min-height: 18rem;" */>}}
+```
+
+**Example:**
+
+```{{</* iframe src="frame-example.html" style="min-height: 18rem; border: 1px solid #d0d7de; border-radius: 0.75rem;" */>}}```

content/content-formatting-examples/docsy/readfile.md → content/content-formatting-examples/docsy/readfile/_index.md

@@ -9,7 +9,7 @@ draft: true
 The `readfile` shortcode includes the contents of a file inline. When `code="true"` is set, the contents are rendered inside a code block.
 
 ```text
-{{</* readfile file="/static/examples/openapi/example.json" code="true" lang="json" */>}}
+{{</* readfile file="example.json" code="true" lang="json" */>}}
 ```
 
-{{< readfile file="/static/examples/openapi/example.json" code="true" lang="json" >}}
+{{< readfile file="example.json" code="true" lang="json" >}}

content/content-formatting-examples/docsy/redoc.md → content/content-formatting-examples/docsy/redoc/_index.md

@@ -7,9 +7,9 @@ draft: true
 ---
 
 ```text
-{{</* redoc "examples/openapi/example.json" */>}}
+{{</* redoc "example.json" */>}}
 ```
 
 **Example:**
 
-{{< redoc "examples/openapi/example.json" >}}
+{{< redoc "example.json" >}}

content/content-formatting-examples/docsy/redoc/example.json

@@ -0,0 +1,69 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Example Academy API",
+    "version": "1.0.0",
+    "description": "A sample API specification for demonstrating the Redoc and SwaggerUI shortcodes."
+  },
+  "paths": {
+    "/api/courses": {
+      "get": {
+        "summary": "List courses",
+        "description": "Returns a list of all available courses.",
+        "responses": {
+          "200": {
+            "description": "A list of courses.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Course"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/courses/{id}": {
+      "get": {
+        "summary": "Get a course",
+        "description": "Returns a single course by ID.",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": { "type": "string" }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A course object.",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/Course" }
+              }
+            }
+          },
+          "404": { "description": "Course not found." }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Course": {
+        "type": "object",
+        "properties": {
+          "id": { "type": "string", "example": "cloud-101" },
+          "title": { "type": "string", "example": "Cloud Fundamentals" },
+          "description": { "type": "string", "example": "An introduction to cloud computing concepts." },
+          "duration": { "type": "string", "example": "2 hours" }
+        }
+      }
+    }
+  }
+}

content/content-formatting-examples/docsy/swaggerui.md → content/content-formatting-examples/docsy/swaggerui/_index.md

@@ -4,13 +4,12 @@ linkTitle: SwaggerUI
 weight: 11
 description: Render the Docsy swaggerui shortcode.
 draft: true
-type: swagger
 ---
 
 ```text
-{{</* swaggerui src="/academy/examples/openapi/example.json" */>}}
+{{</* swaggerui src="example.json" */>}}
 ```
 
 **Example:**
 
-{{< swaggerui src="/academy/examples/openapi/example.json" >}}
+{{< swaggerui src="example.json" >}}

content/content-formatting-examples/docsy/swaggerui/example.json

@@ -0,0 +1,69 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Example Academy API",
+    "version": "1.0.0",
+    "description": "A sample API specification for demonstrating the Redoc and SwaggerUI shortcodes."
+  },
+  "paths": {
+    "/api/courses": {
+      "get": {
+        "summary": "List courses",
+        "description": "Returns a list of all available courses.",
+        "responses": {
+          "200": {
+            "description": "A list of courses.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Course"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/courses/{id}": {
+      "get": {
+        "summary": "Get a course",
+        "description": "Returns a single course by ID.",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": { "type": "string" }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A course object.",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/Course" }
+              }
+            }
+          },
+          "404": { "description": "Course not found." }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Course": {
+        "type": "object",
+        "properties": {
+          "id": { "type": "string", "example": "cloud-101" },
+          "title": { "type": "string", "example": "Cloud Fundamentals" },
+          "description": { "type": "string", "example": "An introduction to cloud computing concepts." },
+          "duration": { "type": "string", "example": "2 hours" }
+        }
+      }
+    }
+  }
+}

content/content-formatting-examples/docsy/tabpane-tab.md → content/content-formatting-examples/docsy/tabpane-tab/_index.md

@@ -22,7 +22,7 @@ This is the first rendered tab.
 {{< /tab >}}
 
 {{% tab header="Image" lang="en" %}}
-![Rendered tab image](/examples/images/exoscale-icon.png)
+![Rendered tab image](exoscale-icon.png)
 {{< /tab >}}
 
 {{< /tabpane >}}

content/content-formatting-examples/docsy/tabpanel.md → content/content-formatting-examples/docsy/tabpanel/_index.md

@@ -43,7 +43,7 @@ Tabs help organize related content.
 
 Here is an example image:
 
-![Spruce shoot example image](/academy/examples/images/layer5-academy-icon.svg)
+![Spruce shoot example image](layer5-academy-icon.svg)
 
 {{< /tab >}}
 

content/content-formatting-examples/hugo-builtins/figure/_index.md

@@ -0,0 +1,15 @@
+---
+title: Figure
+linkTitle: Figure
+weight: 1
+description: Render the Hugo figure shortcode.
+draft: true
+---
+
+```text
+{{</* figure src="exoscale-icon.png" alt="Exoscale icon" caption="Caption text." */>}}
+```
+
+**Example:**
+
+{{< figure src="exoscale-icon.png" alt="Exoscale icon" caption="A Hugo figure shortcode rendering a static image." >}}

content/content-formatting-examples/markdown/responsive-images.md → content/content-formatting-examples/markdown/responsive-images/_index.md

@@ -8,10 +8,8 @@ draft: true
 
 Small images should be shown at their actual size.
 
-![Spruce shoot close-up](/academy/assets/icons/layer5-academy-icon.svg)
+![Spruce shoot close-up](deploy.png)
 
 Large images should always scale down and fit in the content container.
 
-![Large spruce shoot photo](/academy/assets/icons/layer5-academy-icon.svg)
-
-_The photo above of the Spruce Picea abies shoot with foliage buds: Bjørn Erik Pedersen, CC-BY-SA._
+![Large spruce shoot photo](kubernetes-icon.svg)