mirror of
https://github.com/clockworklabs/SpacetimeDB.git
synced 2026-05-10 09:40:23 -04:00
joshua-spacetime
41cfbbc7e0
# Description of Changes This patch does the following: - Adds api reference docs for the module-side query builder in the view docs - Merges the client sdk and subscription docs pages - Keeps subscription and client overview docs high-level (moved all api docs to the language reference docs) - Replaces SQL examples in the docs with the query builder - Replaces SQL subscriptions in the templates with the query builder Note, the last commit in this patch set transitions the templates over to use the query builder instead of SQL subscriptions. This will break them temporarily until #4000 merges. Also note, a lot of this was AI assisted. It can still be improved upon, but it's in a better state than it was. # API and ABI breaking changes N/A # Expected complexity level and risk 1 # Testing N/A --------- Signed-off-by: joshua-spacetime <josh@clockworklabs.io> Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
114 lines
3.6 KiB
TypeScript
114 lines
3.6 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: '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;
|