docs/sidebars.ts at main · agirails/docs · 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';

/**
 * AGIRAILS Documentation Sidebar Configuration
 *
 * Structure follows best practices from Stripe, Vercel, Twilio:
 * - Getting Started (immediate value)
 * - Core Concepts (understanding)
 * - SDK Reference (comprehensive, modular)
 * - Examples (runnable code)
 * - Guides (practical how-to)
 * - Protocol Specs (deep technical)
 */
const sidebars: SidebarsConfig = {
  docsSidebar: [
    // Landing page
    {
      type: 'doc',
      id: 'index',
      label: 'What is AGIRAILS?',
    },

    // Getting Started - Zero to Transaction in 15 min
    {
      type: 'category',
      label: 'Getting Started',
      collapsed: false,
      items: [
        'installation',
        'quick-start',
        'agent-integration',
      ],
    },

    // Core Concepts - Understanding the Protocol
    {
      type: 'category',
      label: 'Core Concepts',
      link: {
        type: 'doc',
        id: 'concepts/index',
      },
      items: [
        'concepts/actp-protocol',
        'concepts/transaction-lifecycle',
        'concepts/escrow-mechanism',
        'concepts/agent-identity',
        'concepts/fee-model',
      ],
    },

    // SDK Reference - Modular API Documentation
    {
      type: 'category',
      label: 'SDK Reference',
      link: {
        type: 'doc',
        id: 'sdk-reference/index',
      },
      items: [
        'sdk-reference/basic-api',
        'sdk-reference/standard-api',
        {
          type: 'category',
          label: 'Advanced API',
          link: {
            type: 'doc',
            id: 'sdk-reference/advanced-api/index',
          },
          items: [
            'sdk-reference/advanced-api/kernel',
            'sdk-reference/advanced-api/escrow',
            'sdk-reference/advanced-api/events',
            'sdk-reference/advanced-api/eas',
            'sdk-reference/advanced-api/quote',
            'sdk-reference/advanced-api/proof-generator',
            'sdk-reference/advanced-api/message-signer',
          ],
        },
        'sdk-reference/registry',
        'sdk-reference/utilities',
        'sdk-reference/errors',
      ],
    },

    // CLI Reference
    {
      type: 'doc',
      id: 'cli-reference',
      label: 'CLI Reference',
    },

    // Examples - Runnable Code
    {
      type: 'doc',
      id: 'examples/index',
      label: 'Examples',
    },

    // Smart Contract Reference
    {
      type: 'doc',
      id: 'contract-reference',
      label: 'Contract Reference',
    },

    // Guides - Practical How-To
    {
      type: 'category',
      label: 'Guides',
      link: {
        type: 'doc',
        id: 'guides/index',
      },
      items: [
        {
          type: 'category',
          label: 'Building AI Agents',
          items: [
            'guides/agents/provider-agent',
            'guides/agents/consumer-agent',
            'guides/agents/autonomous-agent',
          ],
        },
        {
          type: 'category',
          label: 'Integrations',
          items: [
            'guides/integrations/n8n',
            'guides/integrations/claude-plugin',
            'guides/integrations/openclaw',
            'guides/integrations/langchain',
            'guides/integrations/crewai',
          ],
        },
      ],
    },

    // Cookbook - Production-Ready Recipes
    {
      type: 'category',
      label: 'Cookbook',
      link: {
        type: 'doc',
        id: 'cookbook/index',
      },
      items: [
        'cookbook/automated-provider-agent',
        'cookbook/api-pay-per-call',
        'cookbook/multi-agent-budget',
        'cookbook/secure-key-management',
        'cookbook/n8n-workflow',
      ],
    },

    // Error Reference
    {
      type: 'doc',
      id: 'error-reference',
      label: 'Error Reference',
    },

    // Developer Responsibilities
    {
      type: 'doc',
      id: 'developer-responsibilities',
      label: 'Developer Responsibilities',
    },
  ],
};

export default sidebars;