Skip to content

Commit

Permalink
merge components lib
Browse files Browse the repository at this point in the history
  • Loading branch information
armandobelardo committed May 24, 2024
2 parents b3f751c + 63fde71 commit 2323939
Show file tree
Hide file tree
Showing 876 changed files with 58,432 additions and 2,090 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ jobs:
# Chromatic CI config: https://www.chromatic.com/docs/github-actions/
with:
projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
workingDir: packages/ui/app
workingDir: packages/ui/components
onlyChanged: true

fern-generate:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ servers/**/lib
servers/**/dist
servers/**/tsconfig*tsbuildinfo
servers/**/out
clis/**/dist
docker/build

# next
Expand Down
52 changes: 52 additions & 0 deletions clis/docs-migrator/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"name": "@fern-platform/docs-migrator",
"version": "0.0.0",
"repository": {
"type": "git",
"url": "https://github.com/fern-api/fern-platform.git",
"directory": "clis/docs-migrator"
},
"private": true,
"files": [
"dist"
],
"scripts": {
"clean": "rm -rf ./dist && tsc --build --clean",
"compile": "tsc --build",
"test": "vitest --passWithNoTests --globals",
"format": "prettier --write --ignore-unknown --ignore-path ../../shared/.prettierignore \"**\"",
"format:check": "prettier --check --ignore-unknown --ignore-path ../../shared/.prettierignore \"**\"",
"lint:eslint": "eslint --max-warnings 0 . --ignore-path=../../.eslintignore",
"lint:eslint:fix": "pnpm lint:eslint --fix",
"lint:style": "stylelint 'src/**/*.scss' --allow-empty-input --max-warnings 0",
"lint:style:fix": "pnpm lint:style --fix"
},
"keywords": [],
"author": "",
"type": "module",
"source": "src/index.ts",
"module": "src/index.ts",
"main": "src/index.ts",
"dependencies": {
"@fern-fern/docs-config": "^0.22.0",
"@fern-ui/core-utils": "workspace:*",
"execa": "^5.1.1",
"gray-matter": "^4.0.3",
"lodash-es": "^4.17.21",
"rehype-remark": "^10.0.0",
"remark-mdx": "^3.0.1",
"remark-parse": "^11.0.0",
"remark-rehype": "^11.1.0",
"remark-stringify": "^11.0.0",
"unified": "^11.0.4",
"unified-prettier": "^2.0.1",
"js-yaml": "^4.1.0"
},
"devDependencies": {
"@fern-platform/configs": "workspace:*",
"@types/lodash-es": "^4.17.12",
"@types/node": "^18.7.18",
"@types/js-yaml": "^4.0.5",
"vitest": "^1.5.0"
}
}
5 changes: 5 additions & 0 deletions clis/docs-migrator/src/__test__/bland.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { testMigrator } from "./testMigrator";

describe("bland", () => {
testMigrator("bland");
});
32 changes: 32 additions & 0 deletions clis/docs-migrator/src/__test__/fixtures/bland/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Mintlify Starter Kit

Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including

- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components

### 👩‍💻 Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command

```
npm i -g mintlify
```

Run the following command at the root of your documentation (where mint.json is)

```
mintlify dev
```

### 😎 Publishing Changes

Install our Github App to autopropagate changes from youre repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

#### Troubleshooting

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## My Snippet

<Info>This is an example of a reusable snippet</Info>
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: "Batch Calling"
api: "POST https://api.bland.ai/batch"
description: "Send a series of calls with a single api call"
---

### Headers

<ParamField header="authorization" type="string" required>
Your API key for authentication.
</ParamField>

### Body

<ParamField body="base_prompt" type="string" required>
This is the prompt or task used for all the phone calls in the request. Information can be inserted into it surrounding variable names with \{\{curly braces\}\}.

Example:

```json
"You are calling {{business}} to renew their subscription to {{service}} before it expires on {{date}}."
```

</ParamField>

<ParamField body="call_data" type="array" required>
Define a list of calls to make and their properties.

Each call in call_data *must* have a `phone_number` property. Properties are case-sensitive.

Example:

```json
[
{
"phone_number": "1234567890",
"business": "ABC co.",
"service": "Netflix",
"date": "September 4th"
},
{
"phone_number": "32176540987",
"business": "XYZ inc.",
"service": "Window Cleaning",
"date": "December 20th"
}
]
```

</ParamField>

<ParamField body="label" type="string">
Adds a user-friendly label to your batch to keep track of it's original intention. This can help differentiate
multiple call batches that are part of the same Campaign. Shown when a batch is retreived.
</ParamField>

<ParamField body="campaign_id" type="string">
Use ```campaign_id``` to organize related batches together. This can be set manually or auto-generated through
Campaigns.
</ParamField>

<ParamField body="test_mode" type="boolean" default="false">
When this is set to ```true```, only the first call of ```call_data``` will be dispatched. A common use case is to set the first ```phone_number``` value to your own to confirm everything's set up properly.

Includes additional information in the response when true so that it's easier to find any issues.

</ParamField>

<ParamField body="*">
All other parameters supported by the [Send Call](/api-v1/post/calls) endpoint are supported here as well. They will
be applied to each call in the batch.
</ParamField>

### Response

<ResponseField name="message" type="string">
If anything other than "success" is returned, there was an error.
</ResponseField>

<ResponseField name="batch_id" type="string">
The unique identifier for the batch.
</ResponseField>

<ResponseExample>

```json Response
{
"message": "success",
"batch_id": "3p$7rQ3p9sT5bzmF-gen-batch"
}
```

</ResponseExample>
Loading

0 comments on commit 2323939

Please sign in to comment.