xspoonai.github.io/sidebars.ts at main · XSpoonAi/xspoonai.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
import { SidebarsConfig } from '@docusaurus/plugin-content-docs';

/**
 * SpoonOS Cookbook Documentation Sidebar Configuration
 *
 * Organized following DeepWiki/LangChain pattern:
 * - Progressive learning path from basics to advanced
 * - Task-oriented how-to guides
 * - Comprehensive API reference
 * - Practical examples and troubleshooting
 */

const sidebars: SidebarsConfig = {
  // Main documentation sidebar with hierarchical structure
  tutorialSidebar: [
    {
      type: 'category',
      label: '🚀 Getting Started',
      collapsed: false,
      items: [
        'getting-started/installation',
        'getting-started/configuration',
        'getting-started/quick-start',
      ],
    },
    {
      type: 'category',
      label: '🧠 Core Concepts',
      collapsed: false,
      items: [
        'core-concepts/agents',
        'core-concepts/skills',
        'core-concepts/tools',
        'core-concepts/llm-providers',
        'core-concepts/vision',
        'core-concepts/rag',
        'core-concepts/mcp-protocol',
        'core-concepts/Short-term memory',
        'core-concepts/x402-payments',
        'core-concepts/long-term memory',
      ],
    },
    {
      type: 'category',
      label: '📊 Graph System',
      collapsed: false,
      link: {
        type: 'doc',
        id: 'graph-system/index',
      },
      items: [
        'graph-system/quick-start',
        'graph-system/core-concepts',
        'graph-system/building-graphs',
        'graph-system/advanced-features',
        'graph-system/integration',
        'graph-system/examples',
      ],
    },
    {
      type: 'category',
      label: '📖 How-To Guides',
      collapsed: false,
      items: [
        'how-to-guides/build-first-agent',
        'how-to-guides/build-skill-agents',
        'how-to-guides/add-custom-tools',
        'how-to-guides/vibe-coding',
        'how-to-guides/x402-payments',
      ],
    },
    // {
    //   type: 'category',
    //   label: '💻 CLI Usage',
    //   collapsed: false,
    //   items: [
    //     'cli/installation',
    //     'cli/configuration',
    //     'cli/basic-usage',
    //     'cli/advanced-features',
    //     'cli/troubleshooting',
    //   ],
    // },
    {
      type: 'category',
      label: '📚 SpoonOS API Reference',
      collapsed: false,
      link: {
        type: 'doc',
        id: 'api-reference/index',
      },
      items: [
        {
          type: 'autogenerated',
          dirName: 'api-reference/spoon_ai',
        },
      ],
    },
    {
      type: 'category',
      label: '💡 Examples',
      collapsed: true,
      items: [
        'examples/intent-graph-demo',
        'examples/graph-crypto-analysis',
        'examples/mcp-spoon-search-agent',
        'examples/x402-react-agent',
      ],
    },
    {
      type: 'category',
      label: '🔧 Troubleshooting',
      collapsed: true,
      items: [
        'troubleshooting/common-issues',
        'troubleshooting/debugging',
        'troubleshooting/performance',
      ],
    },
  ],
};

export default sidebars;