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
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';

/**
 * AGIRAILS docs IA — Wave A.1 (post-truth-ledger).
 *
 * Five top-level surfaces:
 *   1. Home (index)
 *   2. Start (LLM onboarding + manual + AI-environment matrix)
 *   3. Protocol (canonical spec wrapper)
 *   4. Reference (auto-extracted from truth-ledger)
 *   5. Recipes (merged former guides + cookbook)
 *
 * Old pages (concepts/, sdk-reference/, guides/, cookbook/, examples/,
 * installation, quick-start, cli-reference, contract-reference,
 * error-reference, agent-integration, developer-responsibilities) are
 * NOT in this sidebar. Their URLs 301-redirect via vercel.json.
 */
const sidebars: SidebarsConfig = {
  docsSidebar: [
    {
      type: 'doc',
      id: 'index',
      label: 'What is AGIRAILS?',
    },

    {
      type: 'doc',
      id: 'why',
      label: 'Why AGIRAILS exists',
    },

    {
      type: 'category',
      label: 'Get started',
      collapsed: false,
      link: { type: 'doc', id: 'start/index' },
      items: [
        'start/manual',
        'start/agent-onboarding-prompt',
        {
          type: 'category',
          label: 'Get AGIRAILS into your AI tool',
          link: { type: 'doc', id: 'start/ai-environment/index' },
          items: [
            'start/ai-environment/claude-code',
            'start/ai-environment/claude-skill',
            'start/ai-environment/mcp-server',
            'start/ai-environment/openclaw',
          ],
        },
      ],
    },

    {
      type: 'category',
      label: 'Protocol',
      collapsed: false,
      link: { type: 'doc', id: 'protocol/index' },
      items: [
        'protocol/agirails-md',
        'protocol/covenant',
        'protocol/state-machine',
        'protocol/escrow',
        'protocol/fees',
        'protocol/quote-channel',
        'protocol/identity',
        'protocol/adapters',
        'protocol/web-receipts',
        'protocol/x402',
        'protocol/first-mainnet-transaction',
        'protocol/design-decisions',
        'protocol/walk-away',
      ],
    },

    {
      type: 'category',
      label: 'Recipes',
      link: { type: 'doc', id: 'recipes/index' },
      items: [
        'recipes/provider-agent',
        'recipes/consumer-agent',
        'recipes/autonomous-agent',
        'recipes/gasless-payment',
        'recipes/per-call-api',
        'recipes/quote-negotiation',
        'recipes/dispute-flow',
        'recipes/receipts-and-discovery',
        'recipes/keystore-and-deployment',
        'recipes/production-checklist',
        'recipes/n8n',
        'recipes/langchain',
        'recipes/crewai',
        'recipes/claude-code-plugin',
      ],
    },

    {
      type: 'category',
      label: 'Reference',
      link: { type: 'doc', id: 'reference/index' },
      items: [
        'reference/cli/index',
        {
          type: 'category',
          label: 'Contracts',
          link: { type: 'doc', id: 'reference/contracts/index' },
          items: [
            'reference/contracts/base-mainnet',
            'reference/contracts/base-sepolia',
          ],
        },
        {
          type: 'category',
          label: 'TypeScript SDK',
          link: { type: 'doc', id: 'reference/sdk-js/index' },
          items: [
            'reference/sdk-js/simple',
            'reference/sdk-js/standard',
          ],
        },
        {
          type: 'doc',
          id: 'reference/sdk-python/index',
          label: 'Python SDK',
        },
        'reference/errors/index',
        'reference/mcp-server/index',
        'reference/agirails-md-v4',
        'reference/cross-sdk-divergences',
        'reference/glossary',
      ],
    },

    {
      type: 'category',
      label: 'Security',
      link: { type: 'doc', id: 'security/index' },
      items: [
        'security/threat-model',
        'security/audits',
        'security/contracts',
        'security/formal-verification',
        'security/testing',
        'security/disclosure',
      ],
    },

    {
      type: 'doc',
      id: 'faq/index',
      label: 'FAQ',
    },

  ],
};

export default sidebars;