Skip to content

SmythOS Studio: Open-Source Visual AI Agent Builder and deployable runtime stack from SmythOS. Start with an intuitive drag-and-drop workspace, extend with custom code, and deploy your agents anywhere — local, cloud, or edge — with full governance and control.

Add tutorial workflow for builder page

Muhammad Hamza Khandaee356cd487
diff --git a/packages/app/src/builder-ui/pages/builder/index.ts b/packages/app/src/builder-ui/pages/builder/index.ts
index 53175dd3..bd3e302b 100644
--- a/packages/app/src/builder-ui/pages/builder/index.ts
+++ b/packages/app/src/builder-ui/pages/builder/index.ts
@@ -9,6 +9,7 @@ import {
renderMobileHandler,
} from '@src/builder-ui/ui/react-injects';
import { llmModelsStore } from '@src/shared/state_stores/llm-models';
+import { builderPageTutorialWorkflow } from '../../tutorials';
import { popupValuesDialog } from '../../ui/tw-dialogs';
import { delay } from '../../utils';
import { registerCanvasContextMenu } from '../../workspace/CanvasContextMenu';
@@ -247,6 +248,10 @@ export default async function scripts() {
workspace.addEventListener('AgentReady', async (e) => {
console.log('AgentReady');
+
+ const workflow = builderPageTutorialWorkflow();
+ if (workflow) workflow?.start();
+
dbg.init();
});
diff --git a/packages/app/src/builder-ui/tutorials/index.ts b/packages/app/src/builder-ui/tutorials/index.ts
new file mode 100644
index 00000000..7f2d1b86
--- /dev/null
+++ b/packages/app/src/builder-ui/tutorials/index.ts
@@ -0,0 +1,71 @@
+export const builderPageTutorialWorkflow = () => {
+ const Tutorial = (window as any)?.Tutorial;
+ if (!Tutorial) return null;
+
+ const workflow = new Tutorial({
+ onPopoverRender: (popoverElements) => {
+ // Update the popover title with step count immediately after internal boarding logic
+ setTimeout(() => {
+ popoverElements.popoverTitle.innerText = `${
+ popoverElements.popoverTitle.innerText
+ } (${workflow.currentStep + 1}/${workflow.getSteps().length})`;
+ }, 0);
+ },
+ animate: true,
+ showButtons: true,
+ nextBtnText: 'Next',
+ prevBtnText: 'Previous',
+ closeBtnText: 'Close',
+ padding: 10,
+ opacity: 0.7,
+ });
+
+ workflow.defineSteps([
+ {
+ element: '#workspace-container',
+ popover: {
+ title: '<strong>Welcome to SmythOS Builder</strong>',
+ description:
+ "Welcome to the <strong>SmythOS Builder</strong>! This is your visual canvas where you'll create powerful AI agents by connecting components. Drag, drop, and connect elements to build sophisticated workflows.",
+ preferredPosition: 'center',
+ alignment: 'center',
+ className: 'welcome-builder',
+ },
+ },
+ {
+ element: '#agentBuilder-sidebar',
+ popover: {
+ title: '<strong>Agent Weaver</strong>',
+ description:
+ 'Use <strong>Agent Weaver</strong> to describe your agent in natural language. This AI assistant converts your requirements into functional workflows.',
+ preferredPosition: 'right',
+ alignment: 'start',
+ className: 'weaver-intro',
+ },
+ },
+ {
+ element: '[data-qa="sidebar-components-integrations-panel"]',
+ popover: {
+ title: '<strong>Components & Integrations</strong>',
+ description:
+ 'Access <strong>Components & Integrations</strong> to build your agent. Components provide building blocks with inputs, outputs, and settings, while integrations connect you to external services, APIs, databases, and third-party tools.',
+ preferredPosition: 'right',
+ alignment: 'center',
+ className: 'components-integrations-highlight',
+ },
+ },
+ {
+ element: '[data-qa="builder-toolbar-actions"]',
+ popover: {
+ title: '<strong>Debug, Test & Deploy</strong>',
+ description:
+ 'Use the toolbar to manage your agent lifecycle: <strong>Debug</strong> for component-level inspection and testing, <strong>Test</strong> for Form Preview and API testing, and <strong>Deploy</strong> to make your agent live with SSL/TLS certification and version control.',
+ preferredPosition: 'bottom',
+ alignment: 'center',
+ className: 'toolbar-actions-highlight',
+ },
+ },
+ ]);
+
+ return workflow;
+};