guide
Create interactive guides, tutorials, and documentation with AI assistance. Build step-by-step walkthroughs, embed live code examples, track user progress. Ship better docs 10x faster with full TypeScript support.
guide
Guide.do
Overview
The guide primitive is part of the .do platform's semantic API system. It follows the $.Subject.verb.Object pattern for consistent, intuitive interactions across SDK, CLI, API, and MCP interfaces.
Semantic Pattern
All guide operations follow the semantic $.Guide.verb.Object pattern:
import { $, guide } from 'sdk.do'
// Create resources
await $.Guide.create.Resource({ /* config */ })
// Query data
await $.Guide.get.Data({ /* params */ })
// Update state
await $.Guide.update.Status({ /* changes */ })Quick Start
import { guide } from 'sdk.do'
// Initialize and use the primitive
const result = await guide.operation({
// configuration parameters
})Access Methods
The guide primitive is accessible through multiple interfaces:
SDK
TypeScript/JavaScript library for programmatic access:
import { guide } from 'sdk.do'
await guide.method({ /* ... */ })CLI
Command-line interface for terminal operations:
do guide <command> [options]API
REST/RPC endpoints for HTTP integration:
curl -X POST https://api.do/v1/guide \
-H "Content-Type: application/json" \
-d '{"key":"value"}'MCP
Model Context Protocol for AI assistant integration:
Use guide primitives with AI assistants via MCPRelated Primitives
See other primitives in the development category.