Files
SpacetimeDB/docs/sidebars.ts
Phoebe Goldman c70d00246c Add basic troubleshooting guide (#5142)
# Description of Changes

Adds a basic troubleshooting guide for some common issues we've seen
users encounter.

# API and ABI breaking changes

N/a: it's docs.

# Expected complexity level and risk

1: it's docs.

# Testing

N/a.
2026-06-01 18:57:07 +00:00

124 lines
3.9 KiB
TypeScript

import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
const sidebars: SidebarsConfig = {
sidebar: [
// Ask AI Chat - direct doc link at top level with star icon styling
{
type: 'doc',
id: 'ask-ai/ask-ai',
label: 'Ask AI Chat',
className: 'sidebar-ask-ai',
},
// Intro section header
{
type: 'html',
value: '<div class="spacetime-menu-header">Intro</div>',
defaultStyle: false,
},
// Flatten Getting Started items directly under Intro
{ type: 'autogenerated', dirName: '00100-intro/00100-getting-started' },
{
type: 'category',
label: 'Quickstarts',
collapsed: true,
link: { type: 'doc', id: 'intro/quickstarts/react' },
items: [{ type: 'autogenerated', dirName: '00100-intro/00200-quickstarts' }],
},
{
type: 'category',
label: 'Tutorials',
collapsed: true,
link: { type: 'doc', id: 'intro/tutorials/chat-app' },
items: [{ type: 'autogenerated', dirName: '00100-intro/00300-tutorials' }],
},
// Core Concepts section header
{
type: 'html',
value: '<div class="spacetime-menu-header">Core Concepts</div>',
defaultStyle: false,
},
{
type: 'category',
label: 'Databases',
collapsed: true,
link: { type: 'doc', id: 'core-concepts/databases' },
items: [{ type: 'autogenerated', dirName: '00200-core-concepts/00100-databases' }],
},
{
type: 'category',
label: 'Functions',
collapsed: true,
link: { type: 'doc', id: 'core-concepts/functions' },
items: [{ type: 'autogenerated', dirName: '00200-core-concepts/00200-functions' }],
},
{
type: 'category',
label: 'Tables',
collapsed: true,
link: { type: 'doc', id: 'core-concepts/tables' },
items: [{ type: 'autogenerated', dirName: '00200-core-concepts/00300-tables' }],
},
{
type: 'category',
label: 'Authentication',
collapsed: true,
link: { type: 'doc', id: 'core-concepts/authentication' },
items: [{ type: 'autogenerated', dirName: '00200-core-concepts/00500-authentication' }],
},
{
type: 'category',
label: 'Clients',
collapsed: true,
link: { type: 'doc', id: 'core-concepts/clients' },
items: [
{ type: 'doc', id: 'core-concepts/clients/codegen' },
{ type: 'doc', id: 'core-concepts/clients/connection' },
{ type: 'doc', id: 'core-concepts/clients/sdk-api' },
{
type: 'category',
label: 'Subscriptions',
collapsed: true,
link: { type: 'doc', id: 'core-concepts/subscriptions' },
items: [{ type: 'autogenerated', dirName: '00200-core-concepts/00400-subscriptions' }],
},
{ type: 'doc', id: 'core-concepts/clients/rust-reference' },
{ type: 'doc', id: 'core-concepts/clients/csharp-reference' },
{ type: 'doc', id: 'core-concepts/clients/typescript-reference' },
{ type: 'doc', id: 'core-concepts/clients/unreal-reference' },
],
},
// Developer Resources section header
{
type: 'html',
value: '<div class="spacetime-menu-header">Developer Resources</div>',
defaultStyle: false,
},
{
type: 'ref',
label: 'Basic troubleshooting',
id: 'resources/how-to/troubleshooting',
},
{
type: 'ref',
label: 'Migrating from 1.0 to 2.0',
id: 'resources/how-to/migrating-to-2.0',
},
{
type: 'category',
label: 'How To',
collapsed: true,
items: [{ type: 'autogenerated', dirName: '00300-resources/00100-how-to' }],
},
{
type: 'category',
label: 'References',
collapsed: true,
items: [{ type: 'autogenerated', dirName: '00300-resources/00200-reference' }],
},
],
};
export default sidebars;