New docs

cognesy · Jun 19, 2024 · 02d0157 · 02d0157
1 parent 83fc416
commit 02d0157
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 15 deletions.
diff --git a/docs_mintlify/concepts/overview.mdx b/docs_mintlify/concepts/overview.mdx
@@ -1,12 +1,7 @@
 ## What is Instructor?
 
-Instructor is a library that allows you to extract structured, validated data from multiple types of inputs:
-
- - text,
- - images,
- - or OpenAI style chat sequence arrays.
-
-Instructor is powered by Large Language Models (LLMs).
+Instructor is a library that allows you to get structured, validated data from multiple types of inputs: text,
+ chat messages, or images. It is powered by Large Language Models (LLMs).
 
 The library is inspired by the [Instructor](https://jxnl.github.io/instructor/) for Python created by [Jason Liu](https://twitter.com/jxnlco).
 

diff --git a/docs_mintlify/concepts/why.mdx b/docs_mintlify/concepts/why.mdx
@@ -1,11 +1,14 @@
-## Why use Instructor?
+---
+title: Why use Instructor?
+description: 'Key capabilities of Instructor'
+---
 
 
 Our library introduces three key enhancements:
 
-- **Response Mode:** Specify a PHP model to streamline data extraction.
-- **Validation:** Validates response generated by LLM.
-- **Max Retries:** Set your desired number of retry attempts for requests.
+- **Response Model:** Specify a data model to be returned by LLM to simplify your code.
+- **Validation:** Automatically validate response generated by LLM before you start using it.
+- **Max Retries:** Automated retry attempts for invalid responses.
 
 
 ## A Glimpse into Instructor's Capabilities

diff --git a/docs_mintlify/essentials/installation.mdx b/docs_mintlify/essentials/installation.mdx
@@ -1,6 +1,9 @@
-## Installation
+---
+title: Installation
+description: 'Installing Instructor via Composer'
+---
 
-Installing Instructor is simple. Run following command in your terminal, and you're on your way to a smoother data handling experience!
+Run following command in your terminal, and you're on your way to a smoother data handling experience!
 
 ```bash
 composer install cognesy/instructor-php

diff --git a/docs_mintlify/llm_providers.mdx b/docs_mintlify/llm_providers.mdx
@@ -1,6 +1,6 @@
 ---
-title: Supported LLM Providers
-description: 'Instructor support a number of LLM API providers via a set of preconfigured clients.'
+title: LLM API Providers
+description: 'Instructor supports a number of LLM API providers via a set of preconfigured clients.'
 ---
 
 Only tested providers with examples are listed here.