API reference overview page

Vincent Shadbolt · Vincent Shadbolt · commit c5e0d1678889 · 2024-12-10T16:15:52.000-08:00
diff --git a/getting-started/overview.md b/getting-started/overview.md
@@ -23,6 +23,6 @@ This portal is organized to support users at all experience levels, from foundat
     - [Reverse Resolution](/resolution/guides/reverse-resolution/overview.md)
 - [Unstoppable Partner API](/domain-distribution-and-management/overview.md)
 - [Unstoppable Login](/identity/overview/login-with-unstoppable.md)
-- [API Reference](/openapi/resolution.page.yaml)
+- [API Reference](/openapi/overview.md)
 
 <embed src="/snippets/_developer-survey-embed.md" />
diff --git a/index.mdx b/index.mdx
@@ -47,7 +47,7 @@ export default LandingLayout;
     <ThinTile to="resolution/overview.md" icon={toolkit} header="Resolve Domains in your App">
         Retrieve cryptocurrency addresses, IPFS hashes, and metadata from onchain domains within in your app.
     </ThinTile>
-    <ThinTile to="openapi/index.page.yaml" icon={apiref} header="API Reference">
+    <ThinTile to="openapi/overview.md" icon={apiref} header="API Reference">
         Consult the documentation and live testing features of Unstoppable Domains APIs,
         including the Resolution Service API and Partner API.
     </ThinTile>
diff --git a/openapi/index.page.yaml b/openapi/index.page.yaml
diff --git a/openapi/overview.md b/openapi/overview.md
@@ -0,0 +1,28 @@
+---
+title: Overview of the Unstoppable Domains API Reference
+description: The UD API Reference portal is both a technical resource. This will be useful for technical readers.
+---
+
+# Unstoppable Domains API Reference Portal Overview
+
+This API Reference is designed to help you understand how to build and integrate custom applications using Unstoppable Domains APIs.
+
+## Before You Begin
+
+You'll need the following to get started:
+
+- An [API key](../domain-distribution-and-management/quickstart/retrieve-an-api-key.md)
+
+## How This Portal Is Organized
+
+This portal is organized to support users familair with API implementation. If you're new to crypto and blockchain, consider starting with the [Get Started](../getting-started/overview.md) in the top navbar. Advanced users may wish to explore topics like:
+
+- [Metadata](/openapi/metadata.page.yaml)
+- [Resolution](/openapi/resolution.page.yaml)
+- [Partner](/openapi/partner.page.yaml)
+- [Profile](/openapi/profile-v1.page.yaml)
+- [Messaging](/openapi/messaging-v1.page.yaml)
+- [Login](/openapi/loginref.page.yaml)
+- [Registry](/openapi/registry.page.yaml)
+
+<embed src="/snippets/_developer-survey-embed.md" />
diff --git a/openapi/sidebars.yaml b/openapi/sidebars.yaml
@@ -1,5 +1,6 @@
 pages:
-  - page: index.page.yaml
+  - page: overview.md
+    label: Overview
     separatorLine: true
   - page: metadata.page.yaml
     separatorLine: true
diff --git a/sidebars.yaml b/sidebars.yaml
@@ -229,5 +229,5 @@
     - label: "Namehashing"
       page: getting-started/domain-registry-essentials/namehashing.md
   separatorLine: true
-- link: openapi/index.page.yaml
+- link: /openapi/overview/
   label: API Reference
diff --git a/siteConfig.yaml b/siteConfig.yaml
@@ -48,7 +48,7 @@ nav:
     page: getting-started/overview.md
 
   - label: API Reference
-    page: openapi/index.page.yaml
+    page: openapi/overview.md
 
   - search: true
 
