autogen

1
/**
2
 * Creating a sidebar enables you to:
3
 - create an ordered group of docs
4
 - render a sidebar for each doc of that group
5
 - provide next/previous navigation
6

7
 The sidebars can be generated from the filesystem, or explicitly defined here.
8

9
 Create as many sidebars as you want.
10
 */
11

12
 module.exports = {
13
  docsSidebar: [
14
    'Getting-Started',
15
    {
16
      type: "category",
17
      label: "Installation",
18
      collapsed: true,
19
      items: ["installation/Docker", "installation/Optional-Dependencies"],
20
      link: {
21
        type: 'doc',
22
        id: "installation/Installation"
23
      },
24
    },
25
    {
26
      type: 'category',
27
      label: 'Tutorial',
28
      collapsed: false,
29
      link: {
30
        type: 'generated-index',
31
        title: 'Tutorial',
32
        description: 'Tutorial on the basic concepts of AutoGen',
33
        slug: 'tutorial',
34
      },
35
      items: [
36
        {
37
          type: 'doc',
38
          id: 'tutorial/introduction',
39
          label: 'Introduction',
40
        },
41
        {
42
          type: 'doc',
43
          id: 'tutorial/chat-termination',
44
          label: 'Chat Termination',
45
        },
46
        {
47
          type: 'doc',
48
          id: 'tutorial/human-in-the-loop',
49
          label: 'Human in the Loop',
50
        },
51
        {
52
          type: 'doc',
53
          id: 'tutorial/code-executors',
54
          label: 'Code Executors',
55
        },
56
        {
57
          type: 'doc',
58
          id: 'tutorial/tool-use',
59
          label: 'Tool Use',
60
        },
61
        {
62
          type: 'doc',
63
          id: 'tutorial/conversation-patterns',
64
          label: 'Conversation Patterns',
65
        },
66
        {
67
          type: 'doc',
68
          id: 'tutorial/what-next',
69
          label: 'What Next?',
70
        }
71
      ],
72
    },
73
    {'Use Cases': [{type: 'autogenerated', dirName: 'Use-Cases'}]},
74
    {
75
      type: 'category',
76
      label: 'User Guide',
77
      collapsed: false,
78
      link: {
79
        type: 'generated-index',
80
        title: 'User Guide',
81
        slug: 'topics',
82
      },
83
      items: [{type: 'autogenerated', dirName: 'topics'}]
84
    },
85
    {
86
      type: 'link',
87
      label: 'API Reference',
88
      href: '/docs/reference/agentchat/conversable_agent',
89
    },
90
    {
91
      type: 'doc',
92
      label: 'FAQs',
93
      id: 'FAQ',
94
    },
95
    {
96
      'type': 'category',
97
      'label': 'Ecosystem',
98
      'link': {
99
        type: 'generated-index',
100
        title: 'Ecosystem',
101
        description: 'Learn about the ecosystem of AutoGen',
102
        slug: 'ecosystem',
103
      },
104
      'items': [{type: 'autogenerated', dirName: 'ecosystem'}]
105
    },
106
    {
107
      type: "category",
108
      label: "Contributor Guide",
109
      collapsed: true,
110
      items: [{type: 'autogenerated', dirName: 'contributor-guide'}],
111
      link: {
112
        type: 'generated-index',
113
        title: 'Contributor Guide',
114
        description: 'Learn how to contribute to AutoGen',
115
        slug: 'contributor-guide',
116
      },
117
    },
118
    'Research',
119
    'Migration-Guide'
120
  ],
121
  // pydoc-markdown auto-generated markdowns from docstrings
122
  referenceSideBar: [require("./docs/reference/sidebar.json")],
123
  notebooksSidebar: [
124
    {
125
      type: "category",
126
      label: "Notebooks",
127
      items: [{
128
        type: "autogenerated",
129
        dirName: "notebooks",
130
      },],
131
      link: {
132
        type: 'doc',
133
        id: "notebooks"
134
      },
135
    },
136
  ]
137
};
138