Skip to content

Commit

Permalink
/enterprise
Browse files Browse the repository at this point in the history
  • Loading branch information
dphuang2 committed Apr 17, 2024
1 parent 28dcff0 commit e90c383
Show file tree
Hide file tree
Showing 5 changed files with 261 additions and 1 deletion.
4 changes: 4 additions & 0 deletions generator/konfig-docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,10 @@ async function createConfig() {
label: "Blog",
to: "/blog",
},
{
label: "Enterprise",
to: "/enterprise",
},
],
},
{
Expand Down
19 changes: 19 additions & 0 deletions generator/konfig-docs/src/pages/enterprise/ScheduleDemo.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
export function ScheduleDemo() {
return (
<div className="py-4 px-8 mt-16 mb-8 bg-blue-100 ring-1 shadow-md">
<h3 className="font-bold text-blue-900">
Ready to run an efficient onboarding process with Konfig?
</h3>

<a
target="_blank"
href="https://calendly.com/anhtuan-2/30min"
className="text-blue-900"
>
<button className="font-medium bg-gradient-to-br text-white w-fit text-center px-3 py-2 from-blue-600 to-blue-800 text-sm">
<span>Schedule a demo</span>
</button>
</a>
</div>
);
}
213 changes: 213 additions & 0 deletions generator/konfig-docs/src/pages/enterprise/_index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
import { SdkSignupForm } from "@site/src/components/SdkSignupForm";
import { SdksLink } from "@site/src/components/SdksLink"
import { Figure } from "@site/src/components/Figure"
import Mermaid from '@theme/Mermaid';
import { ScheduleDemo } from "./ScheduleDemo"

<div className="markdown max-w-[760px] px-4 pb-16 pt-16 md:pt-32 mx-auto">

<h1 className="font-extrabold text-4xl md:text-5xl">
<span className="bg-gradient-to-r from-purple-800 to-indigo-600 bg-clip-text text-transparent">AI-powered</span>
*customized* guides for your API
</h1>

Konfig learns from your technical documentation and fetches your customer's configurations to generate *customized* onboarding guides. With Konfig, you can run an efficient onboarding process by spending less time handholding customers.

<ScheduleDemo/>

## How Konfig Works


### 1. 🛠️ Configure Konfig

Konfig is configured to understand your technical resources and generate customized onboarding guides.

<Mermaid
value={`
graph LR
HWD[Hand-written Documentation] --> Konfig
DP[Dynamic Customer Configurations] --> Konfig
API[OpenAPI Specification] --> Konfig
QA[Onboarding Form Answers] --> Konfig
Konfig --> CG[Custom Guides]
subgraph Configurable Inputs
HWD
DP
API
QA
end
`}
/>

### 2. 📄 Generate custom guides

Easily generate custom guides on the fly that are tailored to your customer's needs.

<div className="max-w-[90vw] block mb-[calc(0.20_*_100%_*_-1)] ">
<div className="scale-75 h-[500px] overflow-scroll origin-top border border-slate-800 shadow-lg p-4 md:p-8">

<h1>{`ACME 🤝 Customer`}</h1>

## KYC API Integration Onboarding Guide for Customer

Welcome to ACME! This guide is intended to assist your integration of our KYC (Know Your Customer) solutions using our API. This document will guide you through setting up your environment, authenticating requests, and making API calls with custom configurations.

### Prerequisites

Before you start, ensure you have:
- Access to your API credentials (API Key).
- Python installed on your system.
- The `requests` library installed in Python (Install using `pip install requests`).

### Environment Setup

#### Base URL

Use the following base URL for all API requests:

```
https://api.acme-kyc.com/v1/
```

#### Authentication

To authenticate your API requests, include your API key in the header of each request as shown:

```python
headers = {
'Authorization': 'Bearer YOUR_API_KEY_HERE',
'Content-Type': 'application/json'
}
\```
Replace `YOUR_API_KEY_HERE` with your actual API key.

### API Endpoints and Usage

Below are the primary endpoints along with Python code snippets for interacting with the KYC system:

#### Initialize KYC Process

This endpoint initializes the KYC process for a customer.

- **Endpoint:** `/initialize`
- **Method:** `POST`

```python
import requests

url = 'https://api.acme-kyc.com/v1/initialize'
headers = {
'Authorization': 'Bearer YOUR_API_KEY_HERE',
'Content-Type': 'application/json'
}
payload = {
'customer_id': 'CUSTOMER_UNIQUE_ID',
'config_template': 'CUSTOM_CONFIGURATION_TEMPLATE',
'additional_info': {
'field1': 'value1',
'field2': 'value2'
}
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())
```

#### Check KYC Status

Use this endpoint to check the KYC status of a customer.

- **Endpoint:** `/status`
- **Method:** `GET`

```python
import requests

url = 'https://api.acme-kyc.com/v1/status'
params = {
'customer_id': 'CUSTOMER_UNIQUE_ID'
}
headers = {
'Authorization': 'Bearer YOUR_API_KEY_HERE'
}

response = requests.get(url, params=params, headers=headers)
print(response.json())
```

And more...

</div>
</div>

### 3. 🤝 Easily onboard more customers

Multiply the efforts of your engineers so they can handle more customers.

<Mermaid
value={`
graph TD
subgraph s1 [" "]
Engineer[👷 Engineer] --> C1[👨‍💼 Customer #1]
Engineer --> C2[👩🏼‍💼 Customer #2]
end
Engineer --> C3[🧑🏾‍💼 Customer #3]
Engineer --> C4[👨🏼‍💼 Customer #4]
subgraph Konfig[Only possible with the efficiency of Konfig]
C3
C4
end

classDef invisible fill: white, stroke: white
class s1 invisible
`}
/>

## More than a chatbot

### 🔗 Fetches customer configurations

Chatbots need to be prompted to understand the customer's needs. Konfig is
configured to understand your customer's needs without any work from your side.

<Mermaid value={`
graph LR
CC[⚙️ Customer Configuration] --> Konfig
`}/>

### 🧠 Deeply understands OpenAPI spec

OpenAPI Specifications are large and complicated. Konfig has a built-in OpenAPI
Specification Understanding Engine that allows Konfig to understand your API
without any work from your side.

<Mermaid value={`
graph LR
OAS[OpenAPI Specification] --> OpenAPI
subgraph Konfig
OpenAPI[🧠 OpenAPI Specification Understanding Engine]
end
`}/>

### ✅ Produces *accurate* guides

We developed an AI-powered rules and nuance understanding engine to ensure
accurate guidance.

- 🤝 Thorough explanations and code snippets
- 🙅‍♂️ No hallucinations

<Mermaid value={`

graph LR
HWD[Hand-written Documentation] --> Rules
QA[Onboarding Form Answers] --> Rules
subgraph Konfig
Rules[🧠 Rule and Nuance Understanding Engine]
end
`}/>

<ScheduleDemo/>

</div>

24 changes: 24 additions & 0 deletions generator/konfig-docs/src/pages/enterprise/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { LayoutWithoutNav } from "@site/src/components/LayoutWithoutNav/LayoutWithoutNav";
import Index from "./_index.mdx";
import Head from "@docusaurus/Head";

export default function SdkPage() {
const description =
"With Konfig, you can run an efficient onboarding process by spending less time handholding customers.";
return (
<LayoutWithoutNav>
<Head>
<title>Konfig for Enterprise APIs</title>
<meta property="og:image" content="/img/konfig-sdks.png" />
<meta property="og:title" content="Konfig for Enterprise" />
<meta property="og:description" content={description} />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:site" content="@konfig" />
<meta name="twitter:title" content="Konfig SDKs for Public APIs" />
<meta name="twitter:description" content={description} />
<meta name="twitter:image" content="/img/konfig-sdks.png" />
</Head>
<Index />
</LayoutWithoutNav>
);
}
2 changes: 1 addition & 1 deletion generator/konfig-docs/tailwind.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
const { fontFamily } = require("tailwindcss/defaultTheme");

module.exports = {
content: ["./src/**/*.{js,jsx,ts,tsx}", "./docs/**/*.mdx"], // my markdown stuff is in ../docs, not /src
content: ["./src/**/*.{js,jsx,ts,tsx,mdx}", "./docs/**/*.mdx"], // my markdown stuff is in ../docs, not /src
darkMode: ["class", '[data-theme="dark"]'], // hooks into docusaurus' dark mode settigns
theme: {
container: {
Expand Down

0 comments on commit e90c383

Please sign in to comment.