Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ddebowczyk committed Aug 29, 2024
1 parent e6fecc0 commit f254705
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 23 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Configuration handling
## Component Container

Instructor uses `Configuration` and `ConmponentConfig` classes to handle
Instructor uses `Configuration` and `ComponentConfig` classes to handle
configuration of all components of the library.


Expand Down
46 changes: 28 additions & 18 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,23 +45,23 @@
"url": "https://cognesy.com/blog"
}
],
"navigation": {
"0": {
"navigation": [
{
"group": "Get Started",
"pages": [
"introduction",
"quickstart",
"llm_providers"
]
},
"1": {
{
"group": "Concepts",
"pages": [
"concepts/overview",
"concepts/why"
]
},
"2": {
{
"group": "Essentials",
"pages": [
"essentials/installation",
Expand All @@ -74,43 +74,53 @@
"essentials/demonstrations"
]
},
"4": {
"group": "Practical techniques",
{
"group": "Advanced Features",
"pages": [
"advanced/model_options",
"advanced/partials",
"advanced/sequences",
"advanced/structures",
"advanced/function_calls",
"advanced/modules"
]
},
{
"group": "Practical Techniques",
"pages": [
"techniques/prompting",
"techniques/classification",
"techniques/search"
]
},
"5": {
{
"group": "Internals",
"pages": [
"internals/instructor",
"internals/configuration",
"internals/component_config",
"internals/lifecycle",
"internals/response_models",
"internals/debugging",
"internals/http",
"internals/events",
"internals/configuration"
"internals/events"
]
},
"6": {
{
"group": "More",
"pages": [
"misc/philosophy",
"misc/contributing",
"misc/help"
]
},
"7": {
{
"group": "Instructor Hub",
"pages": [
"cookbook/introduction",
"cookbook/contributing"
]
},
"8": {
{
"group": "Basics",
"pages": [
"cookbook/examples/basics/basic_use",
Expand All @@ -128,7 +138,7 @@
"cookbook/examples/basics/validation_multifield"
]
},
"9": {
{
"group": "Advanced",
"pages": [
"cookbook/examples/advanced/caching",
Expand All @@ -146,7 +156,7 @@
"cookbook/examples/advanced/structures"
]
},
"10": {
{
"group": "Techniques",
"pages": [
"cookbook/examples/techniques/arbitrary_properties",
Expand All @@ -170,7 +180,7 @@
"cookbook/examples/techniques/translate_ui_fields"
]
},
"11": {
{
"group": "Troubleshooting",
"pages": [
"cookbook/examples/troubleshooting/debugging",
Expand All @@ -180,7 +190,7 @@
"cookbook/examples/troubleshooting/wiretap"
]
},
"12": {
{
"group": "LLM API Support",
"pages": [
"cookbook/examples/api_support/anthropic",
Expand All @@ -196,7 +206,7 @@
"cookbook/examples/api_support/togetherai"
]
}
},
],
"footerSocials": {
"x": "https://x.com/ddebowczyk",
"github": "https://github.com/cognesy/instructor-php",
Expand Down
6 changes: 3 additions & 3 deletions docs/mint.json.template
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
]
},
{
"group": "Advanced",
"group": "Advanced Features",
"pages": [
"/advanced/model_options",
"/advanced/partials",
Expand All @@ -92,7 +92,7 @@
]
},
{
"group": "Practical techniques",
"group": "Practical Techniques",
"pages": [
"/techniques/prompting",
"/techniques/classification",
Expand Down Expand Up @@ -120,7 +120,7 @@
]
},
{
"group": "Instructor Hub",
"group": "Cookbook",
"pages": [
"cookbook/introduction",
"cookbook/contributing"
Expand Down

0 comments on commit f254705

Please sign in to comment.