Skip to content

Commit

Permalink
Adjust sidebar to v0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@guerra2fernando @blythed
guerra2fernando authored and blythed committed Apr 2, 2024
1 parent 33d954b commit fc6757d
Showing 1 changed file with 37 additions and 171 deletions.
208 changes: 37 additions & 171 deletions docs/hr/sidebars.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,43 +22,32 @@ const sidebars = {
label: 'Welcome',
id: 'docs/intro',
},
{
type: 'doc',
label: 'FAQ',
id: 'docs/faq',
},
{
type: 'category',
label: 'Get started',
collapsed: true,
collapsible: true,
collapsed: false,
collapsible: false,
items: [{ type: 'autogenerated', dirName: 'docs/get_started' }],
link: {
type: 'generated-index',
description: 'Get started with SuperDuperDB',
},
},
{
type: 'category',
label: 'Reusable snippets',
collapsed: true,
collapsible: true,
items: [{ type: 'autogenerated', dirName: 'docs/reusable_snippets' }],
link: {
type: 'generated-index',
description: 'Common patterns for quick use',
},
type: 'doc',
label: 'FAQ',
id: 'docs/faq',
},
{
type: 'category',
label: 'Setup',
collapsed: true,
collapsible: true,
collapsed: false,
collapsible: false,
items: [
'docs/setup/configuration',
'docs/setup/sandbox',
'docs/setup/testing',
'docs/setup/observability',
{
type: 'autogenerated',
dirName: 'docs/setup',
},
],
link: {
type: 'generated-index',
Expand All @@ -68,107 +57,41 @@ const sidebars = {
{
type: 'category',
label: 'Data integrations',
link: {
type: 'generated-index',
title: 'Data Integrations',
description:
"Let's dig into our Data Integrations",

},
items: [
'docs/data_integrations/mongodb',
{
type: 'category',
label: 'SQL Databases',
link: {
type: 'doc',
id: 'docs/data_integrations/sql',
},
items: [
'docs/data_integrations/mysql',
'docs/data_integrations/postgresql',
'docs/data_integrations/snowflake',
'docs/data_integrations/sqlite',
'docs/data_integrations/duckdb',
]
},
'docs/data_integrations/pandas',
]
{
type: 'autogenerated',
dirName: 'docs/data_integrations',
},
],
},
{
type: 'category',
label: 'AI integrations',
link:{
type: 'generated-index',
title: 'AI Integrations',
description:
"Learn more about our AI Integrations which consists of AI models, AI APIs and Frameworks",
},
items: [
'docs/ai_integrations/anthropic',
'docs/ai_integrations/cohere',
'docs/ai_integrations/custom',
'docs/ai_integrations/jina',
'docs/ai_integrations/llm',
'docs/ai_integrations/openai',
'docs/ai_integrations/pytorch',
'docs/ai_integrations/sklearn',
'docs/ai_integrations/transformers',
]

items: [
{
type: 'autogenerated',
dirName: 'docs/ai_integrations',
},
],
},
{
type: 'category',
label: 'Fundamentals',
link: {
type: 'doc',
id: 'docs/fundamentals/glossary',

},
items: [
'docs/fundamentals/design',
'docs/fundamentals/datalayer_overview',


{
type: 'category',
label: 'Components',
link: {
type: 'doc',
id: 'docs/fundamentals/component_abstraction',
},
items: [
'docs/fundamentals/document_encoder_abstraction',
'docs/fundamentals/predictors_and_models',
'docs/fundamentals/procedural_vs_declarative_api',
'docs/fundamentals/component_versioning',
]
},
'docs/fundamentals/vector_search_algorithm',
]
{
type: 'autogenerated',
dirName: 'docs/fundamentals',
},
],
},
{
type: 'category',
label: 'How To',
link: {
type: 'doc',
id: 'docs/walkthrough/tutorial_walkthrough',

},
label: 'Walk through',
items: [
'docs/setup/connecting',
'docs/walkthrough/data_encodings_and_schemas',
'docs/walkthrough/inserting_data',
'docs/walkthrough/referring_to_data_from_diverse_sources',
'docs/walkthrough/using_hybrid_storage_to_handle_large_data_blobs',
'docs/walkthrough/selecting_data',
'docs/walkthrough/ai_models',
'docs/walkthrough/training_models',
'docs/walkthrough/apply_models',
'docs/walkthrough/linking_interdependent_models',
'docs/walkthrough/vector_search',
'docs/walkthrough/serialization',
'docs/walkthrough/creating_stacks_of_functionality',
{
type: 'autogenerated',
dirName: 'docs/walkthrough',
},
],
},
{
Expand All @@ -193,63 +116,6 @@ const sidebars = {
'Common and useful use-cases implemented in SuperDuperDB with a walkthrough',
// slug: 'use-cases',
},
// items: [
// {
// type: 'category',
// label: 'Vector Search',
// link: {
// type: 'generated-index',
// description: 'Go through our vector search use cases below ',
// },
// items: [
// 'use_cases/vector_search/plain_vector_search',
// 'use_cases/vector_search/multimodal_image_search_clip',
// 'use_cases/vector_search/video_search',
// 'use_cases/vector_search/chunked_vector_search',
// 'use_cases/vector_search/multi-modal-duckdb',
// 'use_cases/vector_search/snowflake-example',
// ]
// },
// {
// type: 'category',
// label: 'Question Answering',
// link: {
// type: 'generated-index',
// description: 'Go through our Question-Answering application use cases below ',
// },
// items: [
// 'use_cases/question-answering/Chatbot',
// 'use_cases/question-answering/chat_with_your_database',
// 'use_cases/question-answering/voice_memos',
// ]
// },
// {
// type: 'category',
// label: 'Classical ML Applications',
// link: {
// type: 'generated-index',
// description: 'Go through our Classical ML application use cases below ',
// },
// items: [
// 'use_cases/classical_tasks/mnist_torch',
// 'use_cases/classical_tasks/resnet_features',
// 'use_cases/classical_tasks/sentiment_analysis_use_case',
// 'use_cases/classical_tasks/transfer_learning',
// ]
// },
// {
// type: 'category',
// label: 'Productionization',
// link: {
// type: 'generated-index',
// description: 'Use SuperDuperDB in production contexts',
// },
// items: [
// 'use_cases/productionization/sandbox-example',
// ]
// },
// ],

},

{
Expand All @@ -266,11 +132,11 @@ const sidebars = {
label: 'Change log', // The link label
href: 'https://raw.githubusercontent.com/SuperDuperDB/superduperdb/main/CHANGELOG.md', // The external URL
},
// {
// type: 'link',
// label: 'Home', // The link label
// href: '/', // The internal path
// },
{
type: 'link',
label: 'Home', // The link label
href: '/', // The internal path
},
],
},
],
Expand Down

0 comments on commit fc6757d

Please sign in to comment.