nirbarazida
/
promptfoo
mirror of https://github.com/promptfoo/promptfoo


  
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

	
124

	
125

	
126

	
127

	
128

	
129

	
130

	
131

	
132

	
133

	
134

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

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

 Create as many sidebars as you want.
 */

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  // By default, Docusaurus generates a sidebar from the docs folder structure
  promptfoo: [
    {
      type: 'doc',
      id: 'intro',
    },
    {
      type: 'doc',
      id: 'installation',
    },
    {
      type: 'doc',
      id: 'getting-started',
    },
    /*
    {
      type: 'doc',
      id: 'key-concepts',
    },
    */
    {
      type: 'doc',
      id: 'cloud/index',
    },
    {
      type: 'category',
      label: 'Configuration',
      link: {
        type: 'generated-index',
      },
      items: [
        { type: 'doc', id: 'configuration/guide' },
        { type: 'doc', id: 'configuration/reference' },
        { type: 'doc', id: 'configuration/parameters' },
        { type: 'doc', id: 'configuration/chat' },
        { type: 'doc', id: 'configuration/datasets' },
        { type: 'doc', id: 'configuration/scenarios' },
        { type: 'doc', id: 'configuration/caching' },
        { type: 'doc', id: 'configuration/telemetry' },
      ],
    },
    {
      type: 'category',
      label: 'Usage',
      link: {
        type: 'generated-index',
      },
      items: [{ type: 'autogenerated', dirName: 'usage' }],
    },
    {
      type: 'category',
      label: 'Assertions & metrics',
      collapsed: true,
      link: {
        type: 'doc',
        id: 'configuration/expected-outputs/index',
      },
      items: [{ type: 'autogenerated', dirName: 'configuration/expected-outputs' }],
    },
    {
      type: 'category',
      label: 'Providers',
      link: {
        type: 'generated-index',
        slug: '/providers',
      },
      collapsed: true,
      items: [{ type: 'autogenerated', dirName: 'providers' }],
    },
    {
      type: 'category',
      label: 'Integrations',
      link: {
        type: 'generated-index',
      },
      collapsed: true,
      items: [{ type: 'autogenerated', dirName: 'integrations' }],
    },
    {
      type: 'category',
      label: 'Red teaming',
      link: {
        type: 'generated-index',
      },
      items: [
        { type: 'autogenerated', dirName: 'red-team' },
        { type: 'doc', id: 'guides/llm-redteaming' },
      ],
    },
    {
      type: 'category',
      label: 'Guides',
      link: {
        type: 'generated-index',
      },
      items: [{ type: 'autogenerated', dirName: 'guides' }],
    },
    {
      type: 'doc',
      id: 'contributing',
    },
    {
      type: 'doc',
      id: 'faq',
    },
  ],
  redTeamSidebar: [
    {
      type: 'autogenerated',
      dirName: 'red-team', // This should match the directory name under 'docs'
    },
    {
      type: 'doc',
      id: 'guides/llm-redteaming',
    },
  ],
};

module.exports = sidebars;