split tools and other tweaks

split tools into two pages to keep the api page focused on the REST API endpoint. added a note at the top of API pages clarifying API key is required. detailed the format of API key on the auth page. added aliases for assets and components to clean up imports.
fixie-ai · Sep 24, 2024 · 6cdccbd · 6cdccbd
1 parent 0800a56
commit 6cdccbd
Show file tree

Hide file tree

Showing 13 changed files with 385 additions and 334 deletions.
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -34,6 +34,10 @@ export default defineConfig({
         label: 'Quickstart',
         link: 'guides/quickstart'
       },
+      {
+        label: 'Tools in Ultravox',
+        link: '/tools'
+      },
       {
         label: 'API',
         autogenerate: {

diff --git a/docs/src/components/APIKeyRequired.astro b/docs/src/components/APIKeyRequired.astro
@@ -0,0 +1,7 @@
+---
+---
+
+<div class="border-1 border p-4 shadow">
+  <div class="text-large font-bold">API Key Required</div>
+  <div class="">The Ultravox API requires an API key. See <a href="../auth">Authentication</a> for details.</div>
+</div>
diff --git a/docs/src/components/SDKCards.astro b/docs/src/components/SDKCards.astro
@@ -1,11 +1,11 @@
 ---
-import { CardGrid, Card, Icon } from "@astrojs/starlight/components";
+import { CardGrid, Card } from "@astrojs/starlight/components";
 import { Image } from "astro:assets";
-import flutterLogo from "../assets/logos/flutter.svg";
-import jsLogo from "../assets/logos/js.svg";
-import kotlinLogo from "../assets/logos/kotlin.svg";
-import pythonLogo from "../assets/logos/python.svg";
-import ghLogo from "../assets/logos/github-mark.svg";
+import flutterLogo from "@assets/logos/flutter.svg";
+import jsLogo from "@assets/logos/js.svg";
+import kotlinLogo from "@assets/logos/kotlin.svg";
+import pythonLogo from "@assets/logos/python.svg";
+import ghLogo from "@assets/logos/github-mark.svg";
 
 const wordForNum: { [key: number]: string } = {
   3: "three",

diff --git a/docs/src/content/docs/api/accounts.mdx b/docs/src/content/docs/api/accounts.mdx
@@ -3,8 +3,11 @@ title: "Accounts"
 sidebar:
   order: 1
 ---
-import { Badge, Tabs, TabItem } from '@astrojs/starlight/components';
+import { Badge, Tabs, TabItem, Card } from '@astrojs/starlight/components';
+import APIKeyRequired from '@components/APIKeyRequired.astro';
 
+<APIKeyRequired />
+<br />
 Return information about your accounts. Primarily for getting a unique link for subscription management.
 
 ## List Accounts

diff --git a/docs/src/content/docs/api/auth.mdx b/docs/src/content/docs/api/auth.mdx
@@ -6,13 +6,20 @@ sidebar:
 
 import { Tabs, TabItem } from '@astrojs/starlight/components';
 
-:::note
+:::note[Apply for an API Key]
 Using the Ultravox API requires an API key. You can apply for a key [here](https://forms.gle/BNmUBrqymzH3vkxj8).
 :::
 
 ## Base URL
 The Ultravox API is available at `https://api.ultravox.ai/api/`.
 
+## API Keys
+Ultravox API keys are 41 characters long and are made up of two alphanumeric parts separated by a period. The first part is 8 characters long and the second is 32 characters.
+
+For example: `Zk9Ht7Lm.wX7pN9fM3kLj6tRq2bGhA8yE5cZvD4sT`
+
+Throughout the docs we use `aBCDef.123456` for brevity.
+
 ## X-API-Key Header
 When making API calls, pass your key in using the `X-API-Key` header.
 

diff --git a/docs/src/content/docs/api/calls.mdx b/docs/src/content/docs/api/calls.mdx
@@ -4,6 +4,10 @@ sidebar:
   order: 10
 ---
 import { Badge, Tabs, TabItem } from '@astrojs/starlight/components';
+import APIKeyRequired from '@components/APIKeyRequired.astro';
+
+<APIKeyRequired />
+<br />
 
 Calls are what drive all speech-to-speech interactions between your end users and AI. At their most basic level, calls consist of a set of instructions to instruct the LLM how to behave (i.e. the `systemPrompt`) and the selection of the voice the AI should use when speaking.