[docs] Add API Reference links

maxijonson · Aug 15, 2023 · 389789f · 389789f
1 parent e93ffe0
commit 389789f
Show file tree

Hide file tree

Showing 25 changed files with 45 additions and 3 deletions.
diff --git a/packages/docs/contentlayer.config.ts b/packages/docs/contentlayer.config.ts
@@ -25,6 +25,10 @@ export const Doc = defineDocumentType(() => {
                 type: "number",
                 required: false,
             },
+            api: {
+                type: "string",
+                required: false,
+            },
         },
         computedFields: {
             slug: {

diff --git a/.../src/app/docs/[...slug]/components/DocHeader/components/DocHeaderItems/DocHeaderItems.tsx b/.../src/app/docs/[...slug]/components/DocHeader/components/DocHeaderItems/DocHeaderItems.tsx
@@ -1,15 +1,16 @@
 import { Doc } from ".contentlayer/generated";
 import { Stack, Group, Anchor } from "@mantine/core";
-import { BiLogoGithub } from "react-icons/bi";
+import { BiCodeAlt, BiLogoGithub } from "react-icons/bi";
 import DocHeaderItem from "../DocHeaderItem/DocHeaderItem";
+import { API_BASEURL } from "../../../../../../../config/constants";
 
 interface DocHeaderItemsProps {
     doc: Doc;
 }
 
 const DocHeaderItems = ({ doc }: DocHeaderItemsProps) => {
     return (
-        <Stack mt="md">
+        <Stack mt="md" gap="xs">
             <DocHeaderItem label="Docs">
                 <Group>
                     <BiLogoGithub />
@@ -21,6 +22,19 @@ const DocHeaderItems = ({ doc }: DocHeaderItemsProps) => {
                     </Anchor>
                 </Group>
             </DocHeaderItem>
+            {doc.api && (
+                <DocHeaderItem label="API">
+                    <Group>
+                        <BiCodeAlt />
+                        <Anchor
+                            target="_blank"
+                            href={`${API_BASEURL}${doc.api}`}
+                        >
+                            Go to API Reference
+                        </Anchor>
+                    </Group>
+                </DocHeaderItem>
+            )}
         </Stack>
     );
 };

diff --git a/packages/docs/src/components/mdx/MdxUnderConstruction/MdxUnderConstruction.tsx b/packages/docs/src/components/mdx/MdxUnderConstruction/MdxUnderConstruction.tsx
@@ -1,4 +1,5 @@
 import { Alert, Anchor } from "@mantine/core";
+import { API_BASEURL } from "../../../config/constants";
 
 interface MdxUnderConstructionProps {
     path?: string;
@@ -8,7 +9,7 @@ const MdxUnderConstruction = ({ path }: MdxUnderConstructionProps) => {
     if (!path) throw new Error("MdxUnderConstruction: path is required");
 
     const cleanPath = path.startsWith("/") ? path.slice(1) : path;
-    const href = `https://maxijonson.github.io/gpt-turbo/${cleanPath}`;
+    const href = `${API_BASEURL}${cleanPath}`;
 
     return (
         <Alert color="yellow" title="Under construction" icon="🚧">

diff --git a/packages/docs/src/config/constants.ts b/packages/docs/src/config/constants.ts
@@ -3,3 +3,5 @@ export const SHELLNAVBAR_WIDTH = 280;
 export const SHELLASIDE_WIDTH = 260;
 
 export const MDX_ROOT_ID = "__mdx_root__";
+
+export const API_BASEURL = "https://maxijonson.github.io/gpt-turbo/";
diff --git a/packages/docs/src/mdx/docs/callable-function/callable-function-array.mdx b/packages/docs/src/mdx/docs/callable-function/callable-function-array.mdx
@@ -2,6 +2,7 @@
 title: CallableFunctionArray
 description: Represents an array parameter for a callable function.
 order: 5
+api: classes/CallableFunctionArray.html
 ---
 
 <UnderConstruction path="classes/CallableFunctionArray.html" />
diff --git a/packages/docs/src/mdx/docs/callable-function/callable-function-boolean.mdx b/packages/docs/src/mdx/docs/callable-function/callable-function-boolean.mdx
@@ -2,6 +2,7 @@
 title: CallableFunctionBoolean
 description: Represents a boolean parameter for a callable function.
 order: 4
+api: classes/CallableFunctionBoolean.html
 ---
 
 <UnderConstruction path="classes/CallableFunctionBoolean.html" />
diff --git a/packages/docs/src/mdx/docs/callable-function/callable-function-const.mdx b/packages/docs/src/mdx/docs/callable-function/callable-function-const.mdx
@@ -2,6 +2,7 @@
 title: CallableFunctionConst
 description: Represents a const parameter for a callable function.
 order: 9
+api: classes/CallableFunctionConst.html
 ---
 
 <UnderConstruction path="classes/CallableFunctionConst.html" />
diff --git a/packages/docs/src/mdx/docs/callable-function/callable-function-enum.mdx b/packages/docs/src/mdx/docs/callable-function/callable-function-enum.mdx
@@ -2,6 +2,7 @@
 title: CallableFunctionEnum
 description: Represents an enum parameter for a callable function.
 order: 7
+api: classes/CallableFunctionEnum.html
 ---
 
 <UnderConstruction path="classes/CallableFunctionEnum.html" />
diff --git a/packages/docs/src/mdx/docs/callable-function/callable-function-null.mdx b/packages/docs/src/mdx/docs/callable-function/callable-function-null.mdx
@@ -2,6 +2,7 @@
 title: CallableFunctionNull
 description: Represents a null parameter for a callable function.
 order: 8
+api: classes/CallableFunctionNull.html
 ---
 
 <UnderConstruction path="classes/CallableFunctionNull.html" />
diff --git a/packages/docs/src/mdx/docs/callable-function/callable-function-number.mdx b/packages/docs/src/mdx/docs/callable-function/callable-function-number.mdx
@@ -2,6 +2,7 @@
 title: CallableFunctionNumber
 description: Represents a number parameter for a callable function.
 order: 3
+api: classes/CallableFunctionNumber.html
 ---
 
 <UnderConstruction path="classes/CallableFunctionNumber.html" />
diff --git a/packages/docs/src/mdx/docs/callable-function/callable-function-object.mdx b/packages/docs/src/mdx/docs/callable-function/callable-function-object.mdx
@@ -2,6 +2,7 @@
 title: CallableFunctionObject
 description: Represents an object parameter for a callable function.
 order: 6
+api: classes/CallableFunctionObject.html
 ---
 
 <UnderConstruction path="classes/CallableFunctionObject.html" />
diff --git a/...ges/docs/src/mdx/docs/callable-function/callable-function-parameter-factory.mdx b/...ges/docs/src/mdx/docs/callable-function/callable-function-parameter-factory.mdx
@@ -2,6 +2,7 @@
 title: CallableFunctionParameterFactory
 description: Creates the appropriate CallableFunctionParameter based on the json schema passed in.
 order: 10
+api: classes/CallableFunctionParameterFactory.html
 ---
 
 <UnderConstruction path="classes/CallableFunctionParameterFactory.html" />
diff --git a/packages/docs/src/mdx/docs/callable-function/callable-function-parameter.mdx b/packages/docs/src/mdx/docs/callable-function/callable-function-parameter.mdx
@@ -2,6 +2,7 @@
 title: CallableFunctionParameter
 description: The base class for all callable function parameters.
 order: 1
+api: classes/CallableFunctionParameter.html
 ---
 
 <UnderConstruction path="classes/CallableFunctionParameter.html" />
diff --git a/packages/docs/src/mdx/docs/callable-function/callable-function-string.mdx b/packages/docs/src/mdx/docs/callable-function/callable-function-string.mdx
@@ -2,6 +2,7 @@
 title: CallableFunctionString
 description: Represents a string parameter for a callable function.
 order: 2
+api: classes/CallableFunctionString.html
 ---
 
 <UnderConstruction path="classes/CallableFunctionString.html" />
diff --git a/packages/docs/src/mdx/docs/callable-function/callable-function.mdx b/packages/docs/src/mdx/docs/callable-function/callable-function.mdx
@@ -2,6 +2,7 @@
 title: CallableFunction
 description: Represents a callable function for the Chat Completion API's "functions" parameter
 order: 0
+api: classes/CallableFunction.html
 ---
 
 > Callable functions have no effect for conversations in dry mode.

diff --git a/packages/docs/src/mdx/docs/conversation-plugins/authoring-plugins.mdx b/packages/docs/src/mdx/docs/conversation-plugins/authoring-plugins.mdx
@@ -2,6 +2,7 @@
 title: Authoring Conversation Plugins
 description: Create your own conversation plugins for project use or to publish on NPM.
 order: 1
+api: interfaces/ConversationPlugin.html
 ---
 
 Creating plugins can help you (or others) extend the functionnality of a conversation.

diff --git a/packages/docs/src/mdx/docs/conversation/chatcompletion-service.mdx b/packages/docs/src/mdx/docs/conversation/chatcompletion-service.mdx
@@ -2,6 +2,7 @@
 title: ChatCompletionService
 description: Exposes methods to interact with the Chat Completion API.
 order: 6
+api: classes/ChatCompletionService.html
 ---
 
 > This is an internal class. You can interact with it when authoring plugins, but you shouldn't need to instantiate it.

diff --git a/packages/docs/src/mdx/docs/conversation/conversation-callable-functions.mdx b/packages/docs/src/mdx/docs/conversation/conversation-callable-functions.mdx
@@ -2,6 +2,7 @@
 title: ConversationCallableFunctions
 description: Manages the callable functions available to a conversation.
 order: 4
+api: classes/ConversationCallableFunctions.html
 ---
 
 > This is an internal class. You'll interact with it and configure it through the `Conversation` class, but you shouldn't need to instantiate it.

diff --git a/packages/docs/src/mdx/docs/conversation/conversation-config.mdx b/packages/docs/src/mdx/docs/conversation/conversation-config.mdx
@@ -2,6 +2,7 @@
 title: ConversationConfig
 description: Configures the Chat Completion API parameters and Conversation options
 order: 1
+api: classes/ConversationConfig.html
 ---
 
 > This is an internal class. You'll interact with it and configure it through the `Conversation` class, but you shouldn't need to instantiate it.

diff --git a/packages/docs/src/mdx/docs/conversation/conversation-history.mdx b/packages/docs/src/mdx/docs/conversation/conversation-history.mdx
@@ -2,6 +2,7 @@
 title: ConversationHistory
 description: Manages the message history of a conversation.
 order: 3
+api: classes/ConversationHistory.html
 ---
 
 > This is an internal class. You'll interact with it and configure it through the `Conversation` class, but you shouldn't need to instantiate it.

diff --git a/packages/docs/src/mdx/docs/conversation/conversation-plugin-service.mdx b/packages/docs/src/mdx/docs/conversation/conversation-plugin-service.mdx
@@ -2,6 +2,7 @@
 title: ConversationPluginService
 description: Exposes methods to interact with a conversation's plugins.
 order: 7
+api: classes/ConversationPluginService.html
 ---
 
 > This is an internal class. You can interact with it when authoring plugins, but you shouldn't need to instantiate it.

diff --git a/packages/docs/src/mdx/docs/conversation/conversation-plugins.mdx b/packages/docs/src/mdx/docs/conversation/conversation-plugins.mdx
@@ -2,6 +2,7 @@
 title: ConversationPlugins
 description: Manages the plugins of a conversation.
 order: 5
+api: classes/ConversationPlugins.html
 ---
 
 > This is an internal class. You'll interact with it and configure it through the `Conversation` class, but you shouldn't need to instantiate it.

diff --git a/packages/docs/src/mdx/docs/conversation/conversation-request-options.mdx b/packages/docs/src/mdx/docs/conversation/conversation-request-options.mdx
@@ -2,6 +2,7 @@
 title: ConversationRequestOptions
 description: Configures request options to use when sending HTTP requests to OpenAI's API.
 order: 2
+api: classes/ConversationRequestOptions.html
 ---
 
 > This is an internal class. You'll interact with it and configure it through the `Conversation` class, but you shouldn't need to instantiate it.

diff --git a/packages/docs/src/mdx/docs/conversation/conversation.mdx b/packages/docs/src/mdx/docs/conversation/conversation.mdx
@@ -2,6 +2,7 @@
 title: Conversation
 description: GPT Turbo's main class for interacting with the Chat Completion API
 order: 0
+api: classes/Conversation.html
 ---
 
 The `Conversation` class is the main class you'll be interacting with.

diff --git a/packages/docs/src/mdx/docs/message/message.mdx b/packages/docs/src/mdx/docs/message/message.mdx
@@ -2,6 +2,7 @@
 title: Message
 description: Represents a single message in a conversation.
 order: 0
+api: classes/Message.html
 ---
 
 In order to have conversation continuity, every message in the conversation must be (re-)sent to the API when prompting for a new response.