From a634f3b1f49d02ce587d9d26546034b9bf8ef21b Mon Sep 17 00:00:00 2001 From: Nikhil Pareek Date: Fri, 29 Nov 2024 03:57:32 +0530 Subject: [PATCH 1/3] [feat] restructuing and branding --- logo/logo_light.svg | 33 ++++++ mint.json | 108 +++++------------- .../evaluations}/overview.mdx | 0 .../evaluations}/quickstart.mdx | 0 .../conversation/conversationcoherence.mdx | 0 .../conversation/conversationresolution.mdx | 0 .../templates/function/custom.mdx | 0 .../templates/function/safety.mdx | 0 .../evaluations}/templates/function/text.mdx | 0 .../templates/function/validation.mdx | 0 .../templates/futureagi/contexteval.mdx | 0 .../templates/futureagi/deterministiceval.mdx | 0 .../futureagi/imageinputoutputeval.mdx | 0 .../futureagi/imageinstructioneval.mdx | 0 .../templates/futureagi/outputeval.mdx | 0 .../templates/futureagi/prompteval.mdx | 0 .../templates/futureagi/rankingeval.mdx | 0 .../templates/grounded/answersimilarity.mdx | 0 .../templates/grounded/contextsimilarity.mdx | 0 .../llm/contextcontainsenoughinformation.mdx | 0 .../templates/llm/doesresponseanswerquery.mdx | 0 .../templates/llm/faithfulness.mdx | 0 .../templates/llm/gradingcriteria.mdx | 0 .../templates/llm/groundedness.mdx | 0 .../templates/llm/summarizationaccuracy.mdx | 0 .../evaluations}/templates/ragas/Usage.mdx | 0 .../evaluations}/templates/ragas/overview.mdx | 0 27 files changed, 64 insertions(+), 77 deletions(-) create mode 100644 logo/logo_light.svg rename {evaluations => product-guides/evaluations}/overview.mdx (100%) rename {evaluations => product-guides/evaluations}/quickstart.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/conversation/conversationcoherence.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/conversation/conversationresolution.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/function/custom.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/function/safety.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/function/text.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/function/validation.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/futureagi/contexteval.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/futureagi/deterministiceval.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/futureagi/imageinputoutputeval.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/futureagi/imageinstructioneval.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/futureagi/outputeval.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/futureagi/prompteval.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/futureagi/rankingeval.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/grounded/answersimilarity.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/grounded/contextsimilarity.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/llm/contextcontainsenoughinformation.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/llm/doesresponseanswerquery.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/llm/faithfulness.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/llm/gradingcriteria.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/llm/groundedness.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/llm/summarizationaccuracy.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/ragas/Usage.mdx (100%) rename {evaluations => product-guides/evaluations}/templates/ragas/overview.mdx (100%) diff --git a/logo/logo_light.svg b/logo/logo_light.svg new file mode 100644 index 00000000..ac4f4193 --- /dev/null +++ b/logo/logo_light.svg @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/mint.json b/mint.json index d29705d3..ffff3ba6 100644 --- a/mint.json +++ b/mint.json @@ -3,7 +3,7 @@ "name": "Future AGI", "logo": { "dark": "/logo/logo_dark.svg", - "light": "/logo/Text.svg" + "light": "/logo/logo_light.svg" }, "favicon": "/logo/Icon.svg", "background": { @@ -15,7 +15,7 @@ "theme": "prism", "modeToggle": { "default": "dark", - "isHidden": true + "isHidden": false }, "colors": { "primary": "#7857FC", @@ -23,7 +23,7 @@ "dark": "#7A40D9", "background": { "dark": "#090612", - "light": "#F8F5FF" + "light": "#FFFFFF" }, "anchors": { "from": "#7A40D9", @@ -33,32 +33,12 @@ "font": { "family": "Inter", "format": "woff2", - "weight": 800 + "weight": 500 }, "topbarLinks": [ - { - "name": "Support", - "url": "mailto:no-reply@futureagi.com" - }, - { - "name": "GitHub", - "url": "https://github.com/future-agi/client" - }, - { - "name": "LinkedIn", - "url": "https://www.linkedin.com/company/futureagi/" - }, - { - "name": "PyPI", - "url": "https://pypi.org/project/futureagi/" - }, - { - "name": "Website", - "url": "https://futureagi.com" - } ], "topbarCtaButton": { - "name": "Dashboard", + "name": "Sign Up", "url": "https://app.futureagi.com" }, "primaryTab": { @@ -69,71 +49,28 @@ "name": "API Reference", "url": "api-reference" }, - { - "name": "Evaluations", - "url": "evaluations" - }, { "name": "Examples", "url": "product-guides/examples" } ], "anchors": [ - { - "name": "API References", - "icon": "code", - "url": "api-references" - } - ], + ], "navigation": [ { - "group": "API Reference", - "pages": [ - "api-reference/python-sdk-client", - "api-reference/examples-notebook" - ] - }, - { - "group": "Product Guides", + "group": "Getting Started", "pages": [ "product-guides/quickstart/home", - "product-guides/quickstart/quickstart", - "product-guides/quickstart/installation", - "product-guides/quickstart/initialization", - "product-guides/quickstart/logging-an-event", - "product-guides/quickstart/logging-data-formats-for-conversations", - "product-guides/quickstart/error-handling" - ] - }, - { - "group": "Examples", - "pages": [ - "product-guides/examples/examples", - "product-guides/examples/chats", - "product-guides/examples/image-and-text", - "product-guides/examples/prompt-template", - "product-guides/examples/retrieval-augmented-generation-rag" - ] - }, - { - "group": "Integrations", - "pages": [ - "product-guides/integrations/integrations", - "product-guides/integrations/upload-file", - { - "group": "Mongo DB", - "pages": [ - "product-guides/integrations/mongodb/overview", - "product-guides/integrations/mongodb/getting-started" - ] - }, { - "group": "Google BigQuery", + "group": "Quickstart Guide", "pages": [ - "product-guides/integrations/google-bigquery/overview", - "product-guides/integrations/google-bigquery/getting-started", - "product-guides/integrations/google-bigquery/google-bigquery-faq" + "product-guides/quickstart/quickstart", + "product-guides/quickstart/installation", + "product-guides/quickstart/initialization", + "product-guides/quickstart/logging-an-event", + "product-guides/quickstart/logging-data-formats-for-conversations", + "product-guides/quickstart/error-handling" ] } ] @@ -201,6 +138,23 @@ ] } ] + }, + { + "group": "API Reference", + "pages": [ + "api-reference/python-sdk-client", + "api-reference/examples-notebook" + ] + }, + { + "group": "Examples", + "pages": [ + "product-guides/examples/examples", + "product-guides/examples/chats", + "product-guides/examples/image-and-text", + "product-guides/examples/prompt-template", + "product-guides/examples/retrieval-augmented-generation-rag" + ] } ] } diff --git a/evaluations/overview.mdx b/product-guides/evaluations/overview.mdx similarity index 100% rename from evaluations/overview.mdx rename to product-guides/evaluations/overview.mdx diff --git a/evaluations/quickstart.mdx b/product-guides/evaluations/quickstart.mdx similarity index 100% rename from evaluations/quickstart.mdx rename to product-guides/evaluations/quickstart.mdx diff --git a/evaluations/templates/conversation/conversationcoherence.mdx b/product-guides/evaluations/templates/conversation/conversationcoherence.mdx similarity index 100% rename from evaluations/templates/conversation/conversationcoherence.mdx rename to product-guides/evaluations/templates/conversation/conversationcoherence.mdx diff --git a/evaluations/templates/conversation/conversationresolution.mdx b/product-guides/evaluations/templates/conversation/conversationresolution.mdx similarity index 100% rename from evaluations/templates/conversation/conversationresolution.mdx rename to product-guides/evaluations/templates/conversation/conversationresolution.mdx diff --git a/evaluations/templates/function/custom.mdx b/product-guides/evaluations/templates/function/custom.mdx similarity index 100% rename from evaluations/templates/function/custom.mdx rename to product-guides/evaluations/templates/function/custom.mdx diff --git a/evaluations/templates/function/safety.mdx b/product-guides/evaluations/templates/function/safety.mdx similarity index 100% rename from evaluations/templates/function/safety.mdx rename to product-guides/evaluations/templates/function/safety.mdx diff --git a/evaluations/templates/function/text.mdx b/product-guides/evaluations/templates/function/text.mdx similarity index 100% rename from evaluations/templates/function/text.mdx rename to product-guides/evaluations/templates/function/text.mdx diff --git a/evaluations/templates/function/validation.mdx b/product-guides/evaluations/templates/function/validation.mdx similarity index 100% rename from evaluations/templates/function/validation.mdx rename to product-guides/evaluations/templates/function/validation.mdx diff --git a/evaluations/templates/futureagi/contexteval.mdx b/product-guides/evaluations/templates/futureagi/contexteval.mdx similarity index 100% rename from evaluations/templates/futureagi/contexteval.mdx rename to product-guides/evaluations/templates/futureagi/contexteval.mdx diff --git a/evaluations/templates/futureagi/deterministiceval.mdx b/product-guides/evaluations/templates/futureagi/deterministiceval.mdx similarity index 100% rename from evaluations/templates/futureagi/deterministiceval.mdx rename to product-guides/evaluations/templates/futureagi/deterministiceval.mdx diff --git a/evaluations/templates/futureagi/imageinputoutputeval.mdx b/product-guides/evaluations/templates/futureagi/imageinputoutputeval.mdx similarity index 100% rename from evaluations/templates/futureagi/imageinputoutputeval.mdx rename to product-guides/evaluations/templates/futureagi/imageinputoutputeval.mdx diff --git a/evaluations/templates/futureagi/imageinstructioneval.mdx b/product-guides/evaluations/templates/futureagi/imageinstructioneval.mdx similarity index 100% rename from evaluations/templates/futureagi/imageinstructioneval.mdx rename to product-guides/evaluations/templates/futureagi/imageinstructioneval.mdx diff --git a/evaluations/templates/futureagi/outputeval.mdx b/product-guides/evaluations/templates/futureagi/outputeval.mdx similarity index 100% rename from evaluations/templates/futureagi/outputeval.mdx rename to product-guides/evaluations/templates/futureagi/outputeval.mdx diff --git a/evaluations/templates/futureagi/prompteval.mdx b/product-guides/evaluations/templates/futureagi/prompteval.mdx similarity index 100% rename from evaluations/templates/futureagi/prompteval.mdx rename to product-guides/evaluations/templates/futureagi/prompteval.mdx diff --git a/evaluations/templates/futureagi/rankingeval.mdx b/product-guides/evaluations/templates/futureagi/rankingeval.mdx similarity index 100% rename from evaluations/templates/futureagi/rankingeval.mdx rename to product-guides/evaluations/templates/futureagi/rankingeval.mdx diff --git a/evaluations/templates/grounded/answersimilarity.mdx b/product-guides/evaluations/templates/grounded/answersimilarity.mdx similarity index 100% rename from evaluations/templates/grounded/answersimilarity.mdx rename to product-guides/evaluations/templates/grounded/answersimilarity.mdx diff --git a/evaluations/templates/grounded/contextsimilarity.mdx b/product-guides/evaluations/templates/grounded/contextsimilarity.mdx similarity index 100% rename from evaluations/templates/grounded/contextsimilarity.mdx rename to product-guides/evaluations/templates/grounded/contextsimilarity.mdx diff --git a/evaluations/templates/llm/contextcontainsenoughinformation.mdx b/product-guides/evaluations/templates/llm/contextcontainsenoughinformation.mdx similarity index 100% rename from evaluations/templates/llm/contextcontainsenoughinformation.mdx rename to product-guides/evaluations/templates/llm/contextcontainsenoughinformation.mdx diff --git a/evaluations/templates/llm/doesresponseanswerquery.mdx b/product-guides/evaluations/templates/llm/doesresponseanswerquery.mdx similarity index 100% rename from evaluations/templates/llm/doesresponseanswerquery.mdx rename to product-guides/evaluations/templates/llm/doesresponseanswerquery.mdx diff --git a/evaluations/templates/llm/faithfulness.mdx b/product-guides/evaluations/templates/llm/faithfulness.mdx similarity index 100% rename from evaluations/templates/llm/faithfulness.mdx rename to product-guides/evaluations/templates/llm/faithfulness.mdx diff --git a/evaluations/templates/llm/gradingcriteria.mdx b/product-guides/evaluations/templates/llm/gradingcriteria.mdx similarity index 100% rename from evaluations/templates/llm/gradingcriteria.mdx rename to product-guides/evaluations/templates/llm/gradingcriteria.mdx diff --git a/evaluations/templates/llm/groundedness.mdx b/product-guides/evaluations/templates/llm/groundedness.mdx similarity index 100% rename from evaluations/templates/llm/groundedness.mdx rename to product-guides/evaluations/templates/llm/groundedness.mdx diff --git a/evaluations/templates/llm/summarizationaccuracy.mdx b/product-guides/evaluations/templates/llm/summarizationaccuracy.mdx similarity index 100% rename from evaluations/templates/llm/summarizationaccuracy.mdx rename to product-guides/evaluations/templates/llm/summarizationaccuracy.mdx diff --git a/evaluations/templates/ragas/Usage.mdx b/product-guides/evaluations/templates/ragas/Usage.mdx similarity index 100% rename from evaluations/templates/ragas/Usage.mdx rename to product-guides/evaluations/templates/ragas/Usage.mdx diff --git a/evaluations/templates/ragas/overview.mdx b/product-guides/evaluations/templates/ragas/overview.mdx similarity index 100% rename from evaluations/templates/ragas/overview.mdx rename to product-guides/evaluations/templates/ragas/overview.mdx From 2708266e61cdfcfafb54ce6ff1bab8a486254822 Mon Sep 17 00:00:00 2001 From: Nikhil Pareek Date: Fri, 29 Nov 2024 04:29:44 +0530 Subject: [PATCH 2/3] [feat] more structuring and branding --- .../examples => examples}/chats.mdx | 0 .../examples => examples}/examples.mdx | 0 .../examples => examples}/image-and-text.mdx | 0 .../examples => examples}/prompt-template.mdx | 0 .../retrieval-augmented-generation-rag.mdx | 0 .../quickstart => future-agi}/home.mdx | 0 .../google-bigquery/getting-started.mdx | 0 .../google-bigquery/google-bigquery-faq.mdx | 0 .../integrations/google-bigquery/overview.mdx | 0 .../integrations/integrations.mdx | 0 .../integrations/mongodb/getting-started.mdx | 0 .../integrations/mongodb/overview.mdx | 0 .../integrations/upload-file.mdx | 0 .../products}/evaluations/overview.mdx | 0 .../products}/evaluations/quickstart.mdx | 0 .../conversation/conversationcoherence.mdx | 0 .../conversation/conversationresolution.mdx | 0 .../evaluations/templates/function/custom.mdx | 0 .../evaluations/templates/function/safety.mdx | 0 .../evaluations/templates/function/text.mdx | 0 .../templates/function/validation.mdx | 0 .../templates/futureagi/contexteval.mdx | 0 .../templates/futureagi/deterministiceval.mdx | 0 .../futureagi/imageinputoutputeval.mdx | 0 .../futureagi/imageinstructioneval.mdx | 0 .../templates/futureagi/outputeval.mdx | 0 .../templates/futureagi/prompteval.mdx | 0 .../templates/futureagi/rankingeval.mdx | 0 .../templates/grounded/answersimilarity.mdx | 0 .../templates/grounded/contextsimilarity.mdx | 0 .../llm/contextcontainsenoughinformation.mdx | 0 .../templates/llm/doesresponseanswerquery.mdx | 0 .../templates/llm/faithfulness.mdx | 0 .../templates/llm/gradingcriteria.mdx | 0 .../templates/llm/groundedness.mdx | 0 .../templates/llm/summarizationaccuracy.mdx | 0 .../evaluations/templates/ragas/Usage.mdx | 0 .../evaluations/templates/ragas/overview.mdx | 0 .../quickstart/error-handling.mdx | 0 .../quickstart/initialization.mdx | 0 .../quickstart/installation.mdx | 0 .../quickstart/logging-an-event.mdx | 0 ...logging-data-formats-for-conversations.mdx | 0 .../quickstart/quickstart.mdx | 0 mint.json | 91 ++++++++++--------- sdk-reference/sdk-reference.mdx | 0 stype.css | 6 ++ 47 files changed, 53 insertions(+), 44 deletions(-) rename {product-guides/examples => examples}/chats.mdx (100%) rename {product-guides/examples => examples}/examples.mdx (100%) rename {product-guides/examples => examples}/image-and-text.mdx (100%) rename {product-guides/examples => examples}/prompt-template.mdx (100%) rename {product-guides/examples => examples}/retrieval-augmented-generation-rag.mdx (100%) rename {product-guides/quickstart => future-agi}/home.mdx (100%) rename {product-guides => future-agi}/integrations/google-bigquery/getting-started.mdx (100%) rename {product-guides => future-agi}/integrations/google-bigquery/google-bigquery-faq.mdx (100%) rename {product-guides => future-agi}/integrations/google-bigquery/overview.mdx (100%) rename {product-guides => future-agi}/integrations/integrations.mdx (100%) rename {product-guides => future-agi}/integrations/mongodb/getting-started.mdx (100%) rename {product-guides => future-agi}/integrations/mongodb/overview.mdx (100%) rename {product-guides => future-agi}/integrations/upload-file.mdx (100%) rename {product-guides => future-agi/products}/evaluations/overview.mdx (100%) rename {product-guides => future-agi/products}/evaluations/quickstart.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/conversation/conversationcoherence.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/conversation/conversationresolution.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/function/custom.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/function/safety.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/function/text.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/function/validation.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/futureagi/contexteval.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/futureagi/deterministiceval.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/futureagi/imageinputoutputeval.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/futureagi/imageinstructioneval.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/futureagi/outputeval.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/futureagi/prompteval.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/futureagi/rankingeval.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/grounded/answersimilarity.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/grounded/contextsimilarity.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/llm/contextcontainsenoughinformation.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/llm/doesresponseanswerquery.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/llm/faithfulness.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/llm/gradingcriteria.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/llm/groundedness.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/llm/summarizationaccuracy.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/ragas/Usage.mdx (100%) rename {product-guides => future-agi/products}/evaluations/templates/ragas/overview.mdx (100%) rename {product-guides => future-agi}/quickstart/error-handling.mdx (100%) rename {product-guides => future-agi}/quickstart/initialization.mdx (100%) rename {product-guides => future-agi}/quickstart/installation.mdx (100%) rename {product-guides => future-agi}/quickstart/logging-an-event.mdx (100%) rename {product-guides => future-agi}/quickstart/logging-data-formats-for-conversations.mdx (100%) rename {product-guides => future-agi}/quickstart/quickstart.mdx (100%) create mode 100644 sdk-reference/sdk-reference.mdx create mode 100644 stype.css diff --git a/product-guides/examples/chats.mdx b/examples/chats.mdx similarity index 100% rename from product-guides/examples/chats.mdx rename to examples/chats.mdx diff --git a/product-guides/examples/examples.mdx b/examples/examples.mdx similarity index 100% rename from product-guides/examples/examples.mdx rename to examples/examples.mdx diff --git a/product-guides/examples/image-and-text.mdx b/examples/image-and-text.mdx similarity index 100% rename from product-guides/examples/image-and-text.mdx rename to examples/image-and-text.mdx diff --git a/product-guides/examples/prompt-template.mdx b/examples/prompt-template.mdx similarity index 100% rename from product-guides/examples/prompt-template.mdx rename to examples/prompt-template.mdx diff --git a/product-guides/examples/retrieval-augmented-generation-rag.mdx b/examples/retrieval-augmented-generation-rag.mdx similarity index 100% rename from product-guides/examples/retrieval-augmented-generation-rag.mdx rename to examples/retrieval-augmented-generation-rag.mdx diff --git a/product-guides/quickstart/home.mdx b/future-agi/home.mdx similarity index 100% rename from product-guides/quickstart/home.mdx rename to future-agi/home.mdx diff --git a/product-guides/integrations/google-bigquery/getting-started.mdx b/future-agi/integrations/google-bigquery/getting-started.mdx similarity index 100% rename from product-guides/integrations/google-bigquery/getting-started.mdx rename to future-agi/integrations/google-bigquery/getting-started.mdx diff --git a/product-guides/integrations/google-bigquery/google-bigquery-faq.mdx b/future-agi/integrations/google-bigquery/google-bigquery-faq.mdx similarity index 100% rename from product-guides/integrations/google-bigquery/google-bigquery-faq.mdx rename to future-agi/integrations/google-bigquery/google-bigquery-faq.mdx diff --git a/product-guides/integrations/google-bigquery/overview.mdx b/future-agi/integrations/google-bigquery/overview.mdx similarity index 100% rename from product-guides/integrations/google-bigquery/overview.mdx rename to future-agi/integrations/google-bigquery/overview.mdx diff --git a/product-guides/integrations/integrations.mdx b/future-agi/integrations/integrations.mdx similarity index 100% rename from product-guides/integrations/integrations.mdx rename to future-agi/integrations/integrations.mdx diff --git a/product-guides/integrations/mongodb/getting-started.mdx b/future-agi/integrations/mongodb/getting-started.mdx similarity index 100% rename from product-guides/integrations/mongodb/getting-started.mdx rename to future-agi/integrations/mongodb/getting-started.mdx diff --git a/product-guides/integrations/mongodb/overview.mdx b/future-agi/integrations/mongodb/overview.mdx similarity index 100% rename from product-guides/integrations/mongodb/overview.mdx rename to future-agi/integrations/mongodb/overview.mdx diff --git a/product-guides/integrations/upload-file.mdx b/future-agi/integrations/upload-file.mdx similarity index 100% rename from product-guides/integrations/upload-file.mdx rename to future-agi/integrations/upload-file.mdx diff --git a/product-guides/evaluations/overview.mdx b/future-agi/products/evaluations/overview.mdx similarity index 100% rename from product-guides/evaluations/overview.mdx rename to future-agi/products/evaluations/overview.mdx diff --git a/product-guides/evaluations/quickstart.mdx b/future-agi/products/evaluations/quickstart.mdx similarity index 100% rename from product-guides/evaluations/quickstart.mdx rename to future-agi/products/evaluations/quickstart.mdx diff --git a/product-guides/evaluations/templates/conversation/conversationcoherence.mdx b/future-agi/products/evaluations/templates/conversation/conversationcoherence.mdx similarity index 100% rename from product-guides/evaluations/templates/conversation/conversationcoherence.mdx rename to future-agi/products/evaluations/templates/conversation/conversationcoherence.mdx diff --git a/product-guides/evaluations/templates/conversation/conversationresolution.mdx b/future-agi/products/evaluations/templates/conversation/conversationresolution.mdx similarity index 100% rename from product-guides/evaluations/templates/conversation/conversationresolution.mdx rename to future-agi/products/evaluations/templates/conversation/conversationresolution.mdx diff --git a/product-guides/evaluations/templates/function/custom.mdx b/future-agi/products/evaluations/templates/function/custom.mdx similarity index 100% rename from product-guides/evaluations/templates/function/custom.mdx rename to future-agi/products/evaluations/templates/function/custom.mdx diff --git a/product-guides/evaluations/templates/function/safety.mdx b/future-agi/products/evaluations/templates/function/safety.mdx similarity index 100% rename from product-guides/evaluations/templates/function/safety.mdx rename to future-agi/products/evaluations/templates/function/safety.mdx diff --git a/product-guides/evaluations/templates/function/text.mdx b/future-agi/products/evaluations/templates/function/text.mdx similarity index 100% rename from product-guides/evaluations/templates/function/text.mdx rename to future-agi/products/evaluations/templates/function/text.mdx diff --git a/product-guides/evaluations/templates/function/validation.mdx b/future-agi/products/evaluations/templates/function/validation.mdx similarity index 100% rename from product-guides/evaluations/templates/function/validation.mdx rename to future-agi/products/evaluations/templates/function/validation.mdx diff --git a/product-guides/evaluations/templates/futureagi/contexteval.mdx b/future-agi/products/evaluations/templates/futureagi/contexteval.mdx similarity index 100% rename from product-guides/evaluations/templates/futureagi/contexteval.mdx rename to future-agi/products/evaluations/templates/futureagi/contexteval.mdx diff --git a/product-guides/evaluations/templates/futureagi/deterministiceval.mdx b/future-agi/products/evaluations/templates/futureagi/deterministiceval.mdx similarity index 100% rename from product-guides/evaluations/templates/futureagi/deterministiceval.mdx rename to future-agi/products/evaluations/templates/futureagi/deterministiceval.mdx diff --git a/product-guides/evaluations/templates/futureagi/imageinputoutputeval.mdx b/future-agi/products/evaluations/templates/futureagi/imageinputoutputeval.mdx similarity index 100% rename from product-guides/evaluations/templates/futureagi/imageinputoutputeval.mdx rename to future-agi/products/evaluations/templates/futureagi/imageinputoutputeval.mdx diff --git a/product-guides/evaluations/templates/futureagi/imageinstructioneval.mdx b/future-agi/products/evaluations/templates/futureagi/imageinstructioneval.mdx similarity index 100% rename from product-guides/evaluations/templates/futureagi/imageinstructioneval.mdx rename to future-agi/products/evaluations/templates/futureagi/imageinstructioneval.mdx diff --git a/product-guides/evaluations/templates/futureagi/outputeval.mdx b/future-agi/products/evaluations/templates/futureagi/outputeval.mdx similarity index 100% rename from product-guides/evaluations/templates/futureagi/outputeval.mdx rename to future-agi/products/evaluations/templates/futureagi/outputeval.mdx diff --git a/product-guides/evaluations/templates/futureagi/prompteval.mdx b/future-agi/products/evaluations/templates/futureagi/prompteval.mdx similarity index 100% rename from product-guides/evaluations/templates/futureagi/prompteval.mdx rename to future-agi/products/evaluations/templates/futureagi/prompteval.mdx diff --git a/product-guides/evaluations/templates/futureagi/rankingeval.mdx b/future-agi/products/evaluations/templates/futureagi/rankingeval.mdx similarity index 100% rename from product-guides/evaluations/templates/futureagi/rankingeval.mdx rename to future-agi/products/evaluations/templates/futureagi/rankingeval.mdx diff --git a/product-guides/evaluations/templates/grounded/answersimilarity.mdx b/future-agi/products/evaluations/templates/grounded/answersimilarity.mdx similarity index 100% rename from product-guides/evaluations/templates/grounded/answersimilarity.mdx rename to future-agi/products/evaluations/templates/grounded/answersimilarity.mdx diff --git a/product-guides/evaluations/templates/grounded/contextsimilarity.mdx b/future-agi/products/evaluations/templates/grounded/contextsimilarity.mdx similarity index 100% rename from product-guides/evaluations/templates/grounded/contextsimilarity.mdx rename to future-agi/products/evaluations/templates/grounded/contextsimilarity.mdx diff --git a/product-guides/evaluations/templates/llm/contextcontainsenoughinformation.mdx b/future-agi/products/evaluations/templates/llm/contextcontainsenoughinformation.mdx similarity index 100% rename from product-guides/evaluations/templates/llm/contextcontainsenoughinformation.mdx rename to future-agi/products/evaluations/templates/llm/contextcontainsenoughinformation.mdx diff --git a/product-guides/evaluations/templates/llm/doesresponseanswerquery.mdx b/future-agi/products/evaluations/templates/llm/doesresponseanswerquery.mdx similarity index 100% rename from product-guides/evaluations/templates/llm/doesresponseanswerquery.mdx rename to future-agi/products/evaluations/templates/llm/doesresponseanswerquery.mdx diff --git a/product-guides/evaluations/templates/llm/faithfulness.mdx b/future-agi/products/evaluations/templates/llm/faithfulness.mdx similarity index 100% rename from product-guides/evaluations/templates/llm/faithfulness.mdx rename to future-agi/products/evaluations/templates/llm/faithfulness.mdx diff --git a/product-guides/evaluations/templates/llm/gradingcriteria.mdx b/future-agi/products/evaluations/templates/llm/gradingcriteria.mdx similarity index 100% rename from product-guides/evaluations/templates/llm/gradingcriteria.mdx rename to future-agi/products/evaluations/templates/llm/gradingcriteria.mdx diff --git a/product-guides/evaluations/templates/llm/groundedness.mdx b/future-agi/products/evaluations/templates/llm/groundedness.mdx similarity index 100% rename from product-guides/evaluations/templates/llm/groundedness.mdx rename to future-agi/products/evaluations/templates/llm/groundedness.mdx diff --git a/product-guides/evaluations/templates/llm/summarizationaccuracy.mdx b/future-agi/products/evaluations/templates/llm/summarizationaccuracy.mdx similarity index 100% rename from product-guides/evaluations/templates/llm/summarizationaccuracy.mdx rename to future-agi/products/evaluations/templates/llm/summarizationaccuracy.mdx diff --git a/product-guides/evaluations/templates/ragas/Usage.mdx b/future-agi/products/evaluations/templates/ragas/Usage.mdx similarity index 100% rename from product-guides/evaluations/templates/ragas/Usage.mdx rename to future-agi/products/evaluations/templates/ragas/Usage.mdx diff --git a/product-guides/evaluations/templates/ragas/overview.mdx b/future-agi/products/evaluations/templates/ragas/overview.mdx similarity index 100% rename from product-guides/evaluations/templates/ragas/overview.mdx rename to future-agi/products/evaluations/templates/ragas/overview.mdx diff --git a/product-guides/quickstart/error-handling.mdx b/future-agi/quickstart/error-handling.mdx similarity index 100% rename from product-guides/quickstart/error-handling.mdx rename to future-agi/quickstart/error-handling.mdx diff --git a/product-guides/quickstart/initialization.mdx b/future-agi/quickstart/initialization.mdx similarity index 100% rename from product-guides/quickstart/initialization.mdx rename to future-agi/quickstart/initialization.mdx diff --git a/product-guides/quickstart/installation.mdx b/future-agi/quickstart/installation.mdx similarity index 100% rename from product-guides/quickstart/installation.mdx rename to future-agi/quickstart/installation.mdx diff --git a/product-guides/quickstart/logging-an-event.mdx b/future-agi/quickstart/logging-an-event.mdx similarity index 100% rename from product-guides/quickstart/logging-an-event.mdx rename to future-agi/quickstart/logging-an-event.mdx diff --git a/product-guides/quickstart/logging-data-formats-for-conversations.mdx b/future-agi/quickstart/logging-data-formats-for-conversations.mdx similarity index 100% rename from product-guides/quickstart/logging-data-formats-for-conversations.mdx rename to future-agi/quickstart/logging-data-formats-for-conversations.mdx diff --git a/product-guides/quickstart/quickstart.mdx b/future-agi/quickstart/quickstart.mdx similarity index 100% rename from product-guides/quickstart/quickstart.mdx rename to future-agi/quickstart/quickstart.mdx diff --git a/mint.json b/mint.json index ffff3ba6..3546fa14 100644 --- a/mint.json +++ b/mint.json @@ -5,7 +5,11 @@ "dark": "/logo/logo_dark.svg", "light": "/logo/logo_light.svg" }, + "layout": "sidenav", "favicon": "/logo/Icon.svg", + "sidebar": { + "items": "border" + }, "background": { "style": "gradient" }, @@ -42,16 +46,20 @@ "url": "https://app.futureagi.com" }, "primaryTab": { - "name": "Product Guides" + "name": "Documentation" }, "tabs": [ { "name": "API Reference", "url": "api-reference" }, + { + "name": "SDK Reference", + "url": "sdk-reference" + }, { "name": "Examples", - "url": "product-guides/examples" + "url": "examples" } ], "anchors": [ @@ -59,80 +67,69 @@ ], "navigation": [ { - "group": "Getting Started", + "group": "Introduction", "pages": [ - "product-guides/quickstart/home", - { - "group": "Quickstart Guide", - "pages": [ - "product-guides/quickstart/quickstart", - "product-guides/quickstart/installation", - "product-guides/quickstart/initialization", - "product-guides/quickstart/logging-an-event", - "product-guides/quickstart/logging-data-formats-for-conversations", - "product-guides/quickstart/error-handling" - ] - } + "future-agi/home" ] }, { "group": "Evaluations", "pages": [ - "evaluations/overview", - "evaluations/quickstart", + "future-agi/products/evaluations/overview", + "future-agi/products/evaluations/quickstart", { "group": "Preset Evaluations", "pages": [ { "group": "Conversation", "pages": [ - "evaluations/templates/conversation/conversationcoherence", - "evaluations/templates/conversation/conversationresolution" + "future-agi/products/evaluations/templates/conversation/conversationcoherence", + "future-agi/products/evaluations/templates/conversation/conversationresolution" ] }, { "group": "Function", "pages": [ - "evaluations/templates/function/custom", - "evaluations/templates/function/safety", - "evaluations/templates/function/text", - "evaluations/templates/function/validation" + "future-agi/products/evaluations/templates/function/custom", + "future-agi/products/evaluations/templates/function/safety", + "future-agi/products/evaluations/templates/function/text", + "future-agi/products/evaluations/templates/function/validation" ] }, { "group": "FutureAGI", "pages": [ - "evaluations/templates/futureagi/contexteval", - "evaluations/templates/futureagi/deterministiceval", - "evaluations/templates/futureagi/imageinputoutputeval", - "evaluations/templates/futureagi/imageinstructioneval", - "evaluations/templates/futureagi/outputeval", - "evaluations/templates/futureagi/prompteval", - "evaluations/templates/futureagi/rankingeval" + "future-agi/products/evaluations/templates/futureagi/contexteval", + "future-agi/products/evaluations/templates/futureagi/deterministiceval", + "future-agi/products/evaluations/templates/futureagi/imageinputoutputeval", + "future-agi/products/evaluations/templates/futureagi/imageinstructioneval", + "future-agi/products/evaluations/templates/futureagi/outputeval", + "future-agi/products/evaluations/templates/futureagi/prompteval", + "future-agi/products/evaluations/templates/futureagi/rankingeval" ] }, { "group": "Grounded", "pages": [ - "evaluations/templates/grounded/answersimilarity", - "evaluations/templates/grounded/contextsimilarity" + "future-agi/products/evaluations/templates/grounded/answersimilarity", + "future-agi/products/evaluations/templates/grounded/contextsimilarity" ] }, { "group": "LLM", "pages": [ - "evaluations/templates/llm/contextcontainsenoughinformation", - "evaluations/templates/llm/doesresponseanswerquery", - "evaluations/templates/llm/faithfulness", - "evaluations/templates/llm/gradingcriteria", - "evaluations/templates/llm/summarizationaccuracy" + "future-agi/products/evaluations/templates/llm/contextcontainsenoughinformation", + "future-agi/products/evaluations/templates/llm/doesresponseanswerquery", + "future-agi/products/evaluations/templates/llm/faithfulness", + "future-agi/products/evaluations/templates/llm/gradingcriteria", + "future-agi/products/evaluations/templates/llm/summarizationaccuracy" ] }, { "group": "RAGAS", "pages": [ - "evaluations/templates/ragas/overview", - "evaluations/templates/ragas/usage" + "future-agi/products/evaluations/templates/ragas/overview", + "future-agi/products/evaluations/templates/ragas/usage" ] } ] @@ -149,11 +146,17 @@ { "group": "Examples", "pages": [ - "product-guides/examples/examples", - "product-guides/examples/chats", - "product-guides/examples/image-and-text", - "product-guides/examples/prompt-template", - "product-guides/examples/retrieval-augmented-generation-rag" + "examples/examples", + "examples/chats", + "examples/image-and-text", + "examples/prompt-template", + "examples/retrieval-augmented-generation-rag" + ] + }, + { + "group": "SDK Reference", + "pages": [ + "sdk-reference/sdk-reference" ] } ] diff --git a/sdk-reference/sdk-reference.mdx b/sdk-reference/sdk-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/stype.css b/stype.css new file mode 100644 index 00000000..3d050677 --- /dev/null +++ b/stype.css @@ -0,0 +1,6 @@ +@import url("https://use.typekit.net/zmy3zmk.css"); + +h1, h2, h3 { + font-family: "inter-variable", sans-serif; + font-variation-settings: "slnt" 0, "wght" 600; +} \ No newline at end of file From 18ad8e8aef5d81f99f732811c84c1670dfaee71d Mon Sep 17 00:00:00 2001 From: Srikanth Malyala Date: Fri, 29 Nov 2024 18:55:19 +0530 Subject: [PATCH 3/3] [bugfix] cleanup --- What is Future AGI?.mdx | 0 future-agi/products/evaluations/overview.mdx | 2 -- 2 files changed, 2 deletions(-) delete mode 100644 What is Future AGI?.mdx diff --git a/What is Future AGI?.mdx b/What is Future AGI?.mdx deleted file mode 100644 index e69de29b..00000000 diff --git a/future-agi/products/evaluations/overview.mdx b/future-agi/products/evaluations/overview.mdx index 7b56613b..46071c59 100644 --- a/future-agi/products/evaluations/overview.mdx +++ b/future-agi/products/evaluations/overview.mdx @@ -11,5 +11,3 @@ description: Evaluations are a way to evaluate the quality of your models. Run preset evaluations on the Future AGI Platform - -