surrealdb · macjuul · Sep 18, 2025 · Sep 18, 2025
diff --git a/.mdxlintrc.yaml b/.mdxlintrc.yaml
@@ -0,0 +1,7 @@
+settings:
+  bullet: '-'
+plugins:
+  - remark-gfm
+  - ["remark-frontmatter", ["yaml"]]
+  - remark-lint-definition-sort
+  - remark-lint-mdx-jsx-attribute-sort
diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -12,9 +12,9 @@
         "astro": "astro",
         "serve": "bun scripts/serve.ts",
         "ts": "tsc --watch",
-        "quality:check": "biome check .",
-        "quality:apply": "biome check . --write",
-        "quality:apply:unsafe": "biome check . --write --unsafe",
+        "quality:check": "biome check . && mdxlint ./src/content",
+        "quality:apply": "biome check . --write && mdxlint ./src/content --output",
+        "quality:apply:unsafe": "biome check . --write --unsafe && mdxlint ./src/content --output",
         "make:lab": "bun scripts/make-lab.ts",
         "make:llms": "bun scripts/make-llms-txt.ts"
     },
@@ -72,10 +72,15 @@
         "hast-util-from-html": "^2.0.3",
         "hast-util-to-string": "^3.0.1",
         "hastscript": "^9.0.0",
+        "mdxlint": "^1.0.0",
         "node-html-parser": "^6.1.13",
         "rehype-autolink-headings": "^7.1.0",
         "rehype-slug": "^6.0.0",
         "remark-custom-heading-id": "^2.0.0",
+        "remark-frontmatter": "^5.0.0",
+        "remark-gfm": "^4.0.1",
+        "remark-lint-definition-sort": "^1.0.1",
+        "remark-lint-mdx-jsx-attribute-sort": "^1.0.1",
         "sass-embedded": "^1.81.0",
         "tiny-glob": "^0.2.9"
     },

diff --git a/src/content/doc-cloud/advanced-topics/configure-an-instance.mdx b/src/content/doc-cloud/advanced-topics/configure-an-instance.mdx
@@ -14,7 +14,6 @@ import InstanceUsage from "@img/image/cloud/view-instance-usage.png";
 import DeleteInstance from "@img/image/cloud/delete-instance.png";
 import InstanceCapabilities from "@img/image/cloud/instance-capabilities.png";
 
-
 # Configure an Instance
 
 After you have created an Instance, you can configure it to your needs. This includes changing the Instance type, compute nodes, and capabilities. To do this, click on the **Configure Instance** button on the Instance card; this will open up a configuration drawer.
@@ -26,44 +25,42 @@ In the Instance configuration drawer, you can change the following settings:
 - **Capabilities**: the capabilities of the Instance, this controls the functionality available to users such as scripting, guest access, enabled endpoints for RPC and HTTP endpoints. You can also opt into beta features and restrict access to specific resources.
 - **Version**: the version of SurrealDB that will be used for the Instance. If you a new version is available, you will be prompted to upgrade and also see the release notes.
 
-
 ### Instance capabilities
 
 The capabilities you choose will determine the features available to your Instance. This includes scripting, guest access, enabled endpoints for RPC and HTTP and more. For RPC methods, HTTP endpoints and preview features, you can leave pick one of the following options:
 
 - **Allow all by default**: All endpoints are allowed by default and you can then select which endpoints to deny.
 - **Deny all by default**: All endpoints are denied by default and you can then select which endpoints to allow.
 
-On the other hand network access and functions provide a more granular control over the endpoints. 
+On the other hand network access and functions provide a more granular control over the endpoints.
 
-> [!IMPORTANT]
+> \[!IMPORTANT]
 > Learn more about configuring [network access](/docs/cloud/advanced-topics/network-access) in the advanced topics section.
 
 <Image
-alt="Configure an Instance"
-src={{
-	light: LightConfigure,
-	dark: DarkConfigure,
-	}}  
+  alt="Configure an Instance"
+  src={{
+light: LightConfigure,
+dark: DarkConfigure,
+}}
 />
 
 {/* <Image
-alt="Configure an Instance"
-src={{
-	light: InstanceCapabilities,
-	dark: InstanceCapabilities,
-	}}  
-/>
-
-
-<Image
-alt="Instance Usage"
-src={{
-	light: InstanceUsage,
-	dark: InstanceUsage,
-	}}  
-/> */}
-
+  alt="Configure an Instance"
+  src={{
+    light: InstanceCapabilities,
+    dark: InstanceCapabilities,
+    }}  
+  />
+
+
+  <Image
+  alt="Instance Usage"
+  src={{
+    light: InstanceUsage,
+    dark: InstanceUsage,
+    }}  
+  /> */}
 
 ## Upgrade Instance
 
@@ -74,45 +71,43 @@ To upgrade an Instance, you can click the **Upgrade now** button on the Instance
 
 ### Instance type
 
-While the Instance type you choose will determine the compute and memory available to your Instance. Before you hit the limit of your current plan, you can upgrade your plan to a higher tier using this option. 
+While the Instance type you choose will determine the compute and memory available to your Instance. Before you hit the limit of your current plan, you can upgrade your plan to a higher tier using this option.
 
 First, select the **Instance type** option which will open a modal to select the tier you want to upgrade to as shown below. Depending on the tier you choose, and the resources you have allocated, you will be billed accordingly.
 
 <Image
-alt="Instance Type"
-src={{
-	light: InstanceType,
-	dark: InstanceType,
-	}}  
+  alt="Instance Type"
+  src={{
+light: InstanceType,
+dark: InstanceType,
+}}
 />
 
-
 ### Storage capacity
 
 The storage capacity is the amount of storage available to your Instance. This is used to store the database files and can be increased at any time. For paid plans, you can increase the storage capacity up to the maximum limit of your plan.
 
-> [!IMPORTANT]
+> \[!IMPORTANT]
 > Storage expansion is unavailable for free instances. Upgrade your instance to unlock the ability to increase your storage capacity.
 
 <Image
-alt="Instance Usage"
-src={{
-	light: InstanceUsage,
-	dark: InstanceUsage,
-	}}  
-/> 
+  alt="Instance Usage"
+  src={{
+		light: InstanceUsage,
+dark: InstanceUsage,
+}}
+/>
 
-## Pause or Delete an Instance 
+## Pause or Delete an Instance
 
 From the overview page, you can delete an Instance by clicking the option button on the Instance card and selecting **Delete**. This will bring up a confirmation modal. Once confirmed, the Instance will be deleted.
 
 To pause an Instance, click the option button on the Instance card and select **Pause**. This will bring up a confirmation modal. Once confirmed, the Instance will be paused.
 
-
 <Image
-alt="Delete an Instance"
-src={{
-	light: DeleteInstance,
-	dark: DeleteInstance,
-	}}  
+  alt="Delete an Instance"
+  src={{
+light: DeleteInstance,
+dark: DeleteInstance,
+}}
 />
diff --git a/src/content/doc-cloud/advanced-topics/data-export-and-backup.mdx b/src/content/doc-cloud/advanced-topics/data-export-and-backup.mdx
@@ -19,30 +19,29 @@ This section covers the backup and restore options for your Surreal Cloud Instan
 
 Surreal Cloud provides a robust backup and restore solution for your Surreal Cloud instance. You can backup your data to a local file or to an external storage location. You can also restore your data from a backup file.
 
-> [!IMPORTANT]
+> \[!IMPORTANT]
 > Automated backups are not available for free Instances. To enable automated backups, you must upgrade to a [paid plan](/pricing). This gives you access to restore your data from a backup file.
 
-### Restoring from a backup 
+### Restoring from a backup
 
-In the resources section of the Instance dashboard, you can access the list of all your available backups. To restore from a backup, click the **Create from selected** button on the backup you want to restore from. 
+In the resources section of the Instance dashboard, you can access the list of all your available backups. To restore from a backup, click the **Create from selected** button on the backup you want to restore from.
 
 <Image
-alt="Restoring from a backup"
-src={{ 
-	light: BackupLight,
-	dark: BackupDark,
-	}}  
+  alt="Restoring from a backup"
+  src={{ 
+light: BackupLight,
+dark: BackupDark,
+}}
 />
 
-
 This will will take you to the [create a new Instance ](/docs/cloud/getting-started/create-an-instance#create-from-selected) page with the backup option already selected.
 
 <Image
-alt="Restoring from a backup"
-src={{ 
-	light: RestoreLight,
-	dark: RestoreDark,
-	}}  
+  alt="Restoring from a backup"
+  src={{ 
+light: RestoreLight,
+dark: RestoreDark,
+}}
 />
 
 You can also view a list of all available backups from the backup select dropdown in the Instance creation page.
@@ -58,4 +57,3 @@ You can also view a list of all available backups from the backup select dropdow
 - [Configure an Instance](/docs/cloud/advanced-topics/configure-an-instance)
 - [Network Access](/docs/cloud/advanced-topics/network-access)
 - [Migrating Data](/docs/cloud/advanced-topics/migrating-data)
-
diff --git a/src/content/doc-cloud/advanced-topics/index.mdx b/src/content/doc-cloud/advanced-topics/index.mdx
@@ -16,7 +16,6 @@ In this section you will explore the following advanced topics for navigating Su
 - [Search and shortcuts](/docs/cloud/advanced-topics/search-and-shortcuts)
 - [SurrealQL editor](/docs/cloud/advanced-topics/surrealql-editors)
 
+## Next steps
 
-## Next steps 
-
-Explore the advanced topics for navigating Surreal Cloud in Surrealist in detail. 
+Explore the advanced topics for navigating Surreal Cloud in Surrealist in detail.
diff --git a/src/content/doc-cloud/advanced-topics/manage-organisation-permissions.mdx b/src/content/doc-cloud/advanced-topics/manage-organisation-permissions.mdx
@@ -9,13 +9,10 @@ description: Learn how to manage the permissions of your Organisation in Surreal
 
 Surreal Cloud allows you to manage the permissions of your Organisation. This includes adding members to your Organisation, removing members, and changing their permissions (as an owner). In this section, we will go through the different roles and permissions that are available in Surreal Cloud.
 
-
 ## Role permissions
 
 In an Organisation, by default the creator of the Organisation is the owner. The owner can invite new members to the Organisation and change their permissions. In inviting a new member they can be assigned a role of admin or member. The following chart shows the different permissions assigned to each role.
 
-
-
 <table style={{ width: '100%' }}>
   <thead>
     <tr>
@@ -24,10 +21,12 @@ In an Organisation, by default the creator of the Organisation is the owner. The
       <th>Permissions</th>
     </tr>
   </thead>
+
   <tbody>
     <tr>
       <td><strong style={{ whiteSpace: 'nowrap' }}>Owner</strong></td>
       <td>The owner of the Organisation</td>
+
       <td>
         <ul>
           <li>Can manage the Organisation instances, team, usage and billing information</li>
@@ -37,18 +36,22 @@ In an Organisation, by default the creator of the Organisation is the owner. The
         </ul>
       </td>
     </tr>
+
     <tr>
       <td><strong style={{ whiteSpace: 'nowrap' }}>Admin</strong></td>
       <td>An admin of the Organisation</td>
+
       <td>
         <ul>
           <li>Can do everything an owner can do except for managing the [billing information](/docs/cloud/billing-and-support/billing) or update other users permissions</li>
         </ul>
       </td>
     </tr>
+
     <tr>
       <td><strong style={{ whiteSpace: 'nowrap' }}>Member</strong></td>
       <td>A member of the Organisation</td>
+
       <td>
         <ul>
           <li>Can only view the existing Organisation instances, team. Within the team they can only remove themselves</li>
@@ -58,5 +61,5 @@ In an Organisation, by default the creator of the Organisation is the owner. The
   </tbody>
 </table>
 
-> [!NOTE]
-> In the future we will allow users to control permissions granularly for each user, create new roles and manage permissions for each role. 
+> \[!NOTE]
+> In the future we will allow users to control permissions granularly for each user, create new roles and manage permissions for each role.
diff --git a/src/content/doc-cloud/advanced-topics/migrating-data.mdx b/src/content/doc-cloud/advanced-topics/migrating-data.mdx
@@ -9,21 +9,19 @@ description: Surreal Cloud is a hosted version of SurrealDB, providing a fully m
 
 Surreal Cloud is a hosted version of SurrealDB, providing a fully managed, scalable, and secure database solution. This guide will help you migrate your existing SurrealDB Instance to Surreal Cloud.
 
-
 ## Exporting and importing data
 
 1. Export your current data as a `.surql` (SurrealQL) file. You can do this using the [`surreal export`](/docs/surrealdb/cli/export) command in the terminal:
 
 ```bash
 # Example export command to export data to a file called `export.surql` in the downloads directory.
 surreal export --conn <connection-url> --user root --pass secret --ns test --db test downloads/export.surql
-``` 
+```
 
 2. This will create a file called `export.surql` in the current directory.
 
 3. You can now import this file into your Surreal Cloud Instance.
 
-
 ```bash
 surreal import --conn <connection-url> --user root --pass secret --ns test --db test downloads/export.surql
 ```
diff --git a/src/content/doc-cloud/advanced-topics/monitoring/index.mdx b/src/content/doc-cloud/advanced-topics/monitoring/index.mdx
@@ -7,8 +7,7 @@ description: In this section you will learn how to monitor your Surreal Cloud In
 
 # Monitoring
 
-In this section you will learn how to monitor your Surreal Cloud Instance. You will learn how to view the metrics of your Instance and how to configure alerts. 
+In this section you will learn how to monitor your Surreal Cloud Instance. You will learn how to view the metrics of your Instance and how to configure alerts.
 
 - [Metrics](/docs/cloud/advanced-topics/monitoring/metrics)
 - [Logs](/docs/cloud/advanced-topics/monitoring/logs)
-
diff --git a/src/content/doc-cloud/advanced-topics/monitoring/logs.mdx b/src/content/doc-cloud/advanced-topics/monitoring/logs.mdx
@@ -11,21 +11,21 @@ import DarkLogs from "@img/image/cloud/logs.png";
 
 # Logs
 
-In this section you will learn how to view the SurrealDB logs of your Surreal Cloud Instance. 
+In this section you will learn how to view the SurrealDB logs of your Surreal Cloud Instance.
 
-> [!NOTE]
-> Currently, SurrealDB only supports activity logs for instance level events. Audit logs are not supported yet but will be in the future. 
+> \[!NOTE]
+> Currently, SurrealDB only supports activity logs for instance level events. Audit logs are not supported yet but will be in the future.
 
 ## Viewing logs
 
-To view the logs of your Surreal Cloud Instance, navigate to the **monitoring** tab in the sidebar. Under the **logs** option, you will see a list of logs for your Surreal Cloud Instance. 
+To view the logs of your Surreal Cloud Instance, navigate to the **monitoring** tab in the sidebar. Under the **logs** option, you will see a list of logs for your Surreal Cloud Instance.
 
 <Image
-alt="Configure an Instance"
-src={{
-	light: LightLogs,
-	dark: DarkLogs,
-	}}  
+  alt="Configure an Instance"
+  src={{
+light: LightLogs,
+dark: DarkLogs,
+}}
 />
 
 ## Filtering logs
@@ -35,5 +35,3 @@ While viewing the logs of your Surreal Cloud Instance, you can filter the logs b
 - **Level**: this includes the level of the log.
 - **Source**: this includes the source of the log.
 - **Message**: this includes the message of the log.
-
-
diff --git a/src/content/doc-cloud/advanced-topics/monitoring/metrics.mdx b/src/content/doc-cloud/advanced-topics/monitoring/metrics.mdx
@@ -13,22 +13,22 @@ import DarkMetrics from "@img/image/cloud/metrics.png";
 
 In this section you will explore the different metrics that are available for your Surreal Cloud Instance. The following metrics are available for your Surreal Cloud Instance:
 
-- **System**: this includes the compute and memory usage of your Surreal Cloud Instance. 
-- **Connections**: this includes HTTP and RPC requests to your Surreal Cloud Instance. 
-- **Network traffic**: this includes the network egress and ingress traffic to and from your Surreal Cloud Instance. 
+- **System**: this includes the compute and memory usage of your Surreal Cloud Instance.
+- **Connections**: this includes HTTP and RPC requests to your Surreal Cloud Instance.
+- **Network traffic**: this includes the network egress and ingress traffic to and from your Surreal Cloud Instance.
 
-To access the metrics of your Surreal Cloud Instance, navigate to the **monitoring** tab in the sidebar. Under the **metrics** option, you will see a list of metrics for your Surreal Cloud Instance. 
+To access the metrics of your Surreal Cloud Instance, navigate to the **monitoring** tab in the sidebar. Under the **metrics** option, you will see a list of metrics for your Surreal Cloud Instance.
 
 <Image
-alt="Configure an Instance"
-src={{
-	light: LightMetrics,
-	dark: DarkMetrics,
-	}}  
+  alt="Configure an Instance"
+  src={{
+light: LightMetrics,
+dark: DarkMetrics,
+}}
 />
 
-You will see a list of metrics for your Surreal Cloud Instance. 
+You will see a list of metrics for your Surreal Cloud Instance.
 
 ### Filtering metrics
 
-While viewing the metrics of your Surreal Cloud Instance, you can filter the metrics by selecting the **filter** button. This will open a modal where you can select the metrics you want to view. You can filter by the last hour, last 12 hours, last day, last week, and last month. 
+While viewing the metrics of your Surreal Cloud Instance, you can filter the metrics by selecting the **filter** button. This will open a modal where you can select the metrics you want to view. You can filter by the last hour, last 12 hours, last day, last week, and last month.