Skip to content

Commit 41d07a3

Browse files
authored
improve llms text experience (#575)
1 parent 7b6dde5 commit 41d07a3

File tree

2 files changed

+108
-4
lines changed

2 files changed

+108
-4
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ specs/tsp-output
2323
.cursorignore
2424
temp
2525
.env
26+
.vscode
2627

2728
npm-debug.log*
2829
yarn-debug.log*

website/config/pluginsConfig/docusaurus-plugin-llms-txt.ts

Lines changed: 107 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
*/
99

1010
import { PluginConfig } from '@docusaurus/types';
11-
// @ts-ignore - ESM/CJS compatibility issue
12-
import type { PluginOptions } from '@signalwire/docusaurus-plugin-llms-txt/public';
11+
import type { Options as PluginOptions } from '@signalwire/docusaurus-plugin-llms-txt';
1312
export const llmsTxtPlugin: PluginConfig = [
1413
"@signalwire/docusaurus-plugin-llms-txt",
1514
{
@@ -46,6 +45,7 @@ export const llmsTxtPlugin: PluginConfig = [
4645
"/assets/**",
4746
"/404.html",
4847
"/media/**" ,
48+
"/search",
4949
"/"
5050
],
5151
},
@@ -68,17 +68,60 @@ export const llmsTxtPlugin: PluginConfig = [
6868
id: 'swml',
6969
name: 'SWML Documentation',
7070
description: 'The SignalWire Markup Language which allows developers to create communication applications with simple JSON & YAML documents.',
71-
position: 1,
71+
position: 0,
7272
routes: [
7373
{
7474
route: '/swml/**'
7575
}
7676
]
7777
},
78+
{
79+
id: 'sdks',
80+
name: 'SDKs',
81+
description: 'SignalWire Software Development Kits for building real-time communication applications.',
82+
position: 0,
83+
routes: [
84+
{
85+
route: '/sdks/**'
86+
}
87+
],
88+
subsections: [
89+
{
90+
id: 'agents-sdk',
91+
name: 'Agents SDK',
92+
description: 'Build AI-powered voice and messaging applications with the SignalWire Agents SDK.',
93+
routes: [
94+
{
95+
route: '/sdks/agents-sdk/**'
96+
}
97+
]
98+
},
99+
{
100+
id: 'browser-sdk',
101+
name: 'Browser SDK',
102+
description: 'Build WebRTC-based applications with the SignalWire Browser SDK.',
103+
routes: [
104+
{
105+
route: '/sdks/browser-sdk/**'
106+
}
107+
]
108+
},
109+
{
110+
id: 'realtime-sdk',
111+
name: 'Realtime SDK',
112+
description: 'Build real-time communication applications from your backend with the SignalWire Realtime SDK.',
113+
routes: [
114+
{
115+
route: '/sdks/realtime-sdk/**'
116+
}
117+
]
118+
}
119+
]
120+
},
78121
{
79122
id: 'api-ref',
80123
name: 'API OpenAPI Spec',
81-
description: 'The OpenAPI Spec defiitions.',
124+
description: 'The OpenAPI Spec definitions.',
82125
position: 1,
83126
routes: []
84127
},
@@ -88,11 +131,71 @@ export const llmsTxtPlugin: PluginConfig = [
88131
processing: {
89132

90133
attachments: [
134+
{
135+
source: '../specs/swml/tsp-output/@typespec/json-schema/SWMLObject.json',
136+
title: 'SWML JSON Schema',
137+
description: "The JSON Schema definition for SWML (SignalWire Markup Language).",
138+
sectionId: "swml"
139+
},
140+
{
141+
source: '../specs/compatibility-api/_spec_.yaml',
142+
title: 'Compatibility API Spec',
143+
description: "The OpenAPI spec for the SignalWire Compatibility API.",
144+
sectionId: "api-ref"
145+
},
91146
{
92147
source: '../specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml',
93148
title: 'Calling API Spec',
94149
description: "The OpenAPI spec for the SignalWire Calling API.",
95150
sectionId: "api-ref"
151+
},
152+
{
153+
source: '../specs/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml',
154+
title: 'Chat API Spec',
155+
description: "The OpenAPI spec for the SignalWire Chat API.",
156+
sectionId: "api-ref"
157+
},
158+
{
159+
source: '../specs/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml',
160+
title: 'DataSphere API Spec',
161+
description: "The OpenAPI spec for the SignalWire DataSphere API.",
162+
sectionId: "api-ref"
163+
},
164+
{
165+
source: '../specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml',
166+
title: 'Fabric API Spec',
167+
description: "The OpenAPI spec for the SignalWire Fabric API.",
168+
sectionId: "api-ref"
169+
},
170+
{
171+
source: '../specs/signalwire-rest/fax-api/tsp-output/@typespec/openapi3/openapi.yaml',
172+
title: 'Fax API Spec',
173+
description: "The OpenAPI spec for the SignalWire Fax API.",
174+
sectionId: "api-ref"
175+
},
176+
{
177+
source: '../specs/signalwire-rest/logs-api/tsp-output/@typespec/openapi3/openapi.yaml',
178+
title: 'Logs API Spec',
179+
description: "The OpenAPI spec for the SignalWire Logs API.",
180+
sectionId: "api-ref"
181+
},
182+
{
183+
source: '../specs/signalwire-rest/message-api/tsp-output/@typespec/openapi3/openapi.yaml',
184+
title: 'Message API Spec',
185+
description: "The OpenAPI spec for the SignalWire Message API.",
186+
sectionId: "api-ref"
187+
},
188+
{
189+
source: '../specs/signalwire-rest/pubsub-api/tsp-output/@typespec/openapi3/openapi.yaml',
190+
title: 'PubSub API Spec',
191+
description: "The OpenAPI spec for the SignalWire PubSub API.",
192+
sectionId: "api-ref"
193+
},
194+
{
195+
source: '../specs/signalwire-rest/voice-api/tsp-output/@typespec/openapi3/openapi.yaml',
196+
title: 'Voice API Spec',
197+
description: "The OpenAPI spec for the SignalWire Voice API.",
198+
sectionId: "api-ref",
96199
}
97200
]
98201
},

0 commit comments

Comments
 (0)