Skip to content

improve llms text experience #575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 10, 2025
Merged

improve llms text experience #575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83311ef
improve llms text experience
Devon-White Oct 10, 2025
1d537b0
Merge branch 'main' into Devon/update-plugin-config
Devon-White Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ specs/tsp-output
.cursorignore
temp
.env
.vscode

npm-debug.log*
yarn-debug.log*
Expand Down
111 changes: 107 additions & 4 deletions website/config/pluginsConfig/docusaurus-plugin-llms-txt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
*/

import { PluginConfig } from '@docusaurus/types';
// @ts-ignore - ESM/CJS compatibility issue
import type { PluginOptions } from '@signalwire/docusaurus-plugin-llms-txt/public';
import type { Options as PluginOptions } from '@signalwire/docusaurus-plugin-llms-txt';
export const llmsTxtPlugin: PluginConfig = [
"@signalwire/docusaurus-plugin-llms-txt",
{
Expand Down Expand Up @@ -46,6 +45,7 @@ export const llmsTxtPlugin: PluginConfig = [
"/assets/**",
"/404.html",
"/media/**" ,
"/search",
"/"
],
},
Expand All @@ -68,17 +68,60 @@ export const llmsTxtPlugin: PluginConfig = [
id: 'swml',
name: 'SWML Documentation',
description: 'The SignalWire Markup Language which allows developers to create communication applications with simple JSON & YAML documents.',
position: 1,
position: 0,
routes: [
{
route: '/swml/**'
}
]
},
{
id: 'sdks',
name: 'SDKs',
description: 'SignalWire Software Development Kits for building real-time communication applications.',
position: 0,
routes: [
{
route: '/sdks/**'
}
],
subsections: [
{
id: 'agents-sdk',
name: 'Agents SDK',
description: 'Build AI-powered voice and messaging applications with the SignalWire Agents SDK.',
routes: [
{
route: '/sdks/agents-sdk/**'
}
]
},
{
id: 'browser-sdk',
name: 'Browser SDK',
description: 'Build WebRTC-based applications with the SignalWire Browser SDK.',
routes: [
{
route: '/sdks/browser-sdk/**'
}
]
},
{
id: 'realtime-sdk',
name: 'Realtime SDK',
description: 'Build real-time communication applications from your backend with the SignalWire Realtime SDK.',
routes: [
{
route: '/sdks/realtime-sdk/**'
}
]
}
]
},
{
id: 'api-ref',
name: 'API OpenAPI Spec',
description: 'The OpenAPI Spec defiitions.',
description: 'The OpenAPI Spec definitions.',
position: 1,
routes: []
},
Expand All @@ -88,11 +131,71 @@ export const llmsTxtPlugin: PluginConfig = [
processing: {

attachments: [
{
source: '../specs/swml/tsp-output/@typespec/json-schema/SWMLObject.json',
title: 'SWML JSON Schema',
description: "The JSON Schema definition for SWML (SignalWire Markup Language).",
sectionId: "swml"
},
{
source: '../specs/compatibility-api/_spec_.yaml',
title: 'Compatibility API Spec',
description: "The OpenAPI spec for the SignalWire Compatibility API.",
sectionId: "api-ref"
},
{
source: '../specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml',
title: 'Calling API Spec',
description: "The OpenAPI spec for the SignalWire Calling API.",
sectionId: "api-ref"
},
{
source: '../specs/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml',
title: 'Chat API Spec',
description: "The OpenAPI spec for the SignalWire Chat API.",
sectionId: "api-ref"
},
{
source: '../specs/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml',
title: 'DataSphere API Spec',
description: "The OpenAPI spec for the SignalWire DataSphere API.",
sectionId: "api-ref"
},
{
source: '../specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml',
title: 'Fabric API Spec',
description: "The OpenAPI spec for the SignalWire Fabric API.",
sectionId: "api-ref"
},
{
source: '../specs/signalwire-rest/fax-api/tsp-output/@typespec/openapi3/openapi.yaml',
title: 'Fax API Spec',
description: "The OpenAPI spec for the SignalWire Fax API.",
sectionId: "api-ref"
},
{
source: '../specs/signalwire-rest/logs-api/tsp-output/@typespec/openapi3/openapi.yaml',
title: 'Logs API Spec',
description: "The OpenAPI spec for the SignalWire Logs API.",
sectionId: "api-ref"
},
{
source: '../specs/signalwire-rest/message-api/tsp-output/@typespec/openapi3/openapi.yaml',
title: 'Message API Spec',
description: "The OpenAPI spec for the SignalWire Message API.",
sectionId: "api-ref"
},
{
source: '../specs/signalwire-rest/pubsub-api/tsp-output/@typespec/openapi3/openapi.yaml',
title: 'PubSub API Spec',
description: "The OpenAPI spec for the SignalWire PubSub API.",
sectionId: "api-ref"
},
{
source: '../specs/signalwire-rest/voice-api/tsp-output/@typespec/openapi3/openapi.yaml',
title: 'Voice API Spec',
description: "The OpenAPI spec for the SignalWire Voice API.",
sectionId: "api-ref",
}
]
},
Expand Down