Skip to main content

Getting Started with Workflow

How to use and extend the Workflow docs for FleetStudio automation workflows.

Prerequisites​

  • Access to this docs repo (fleet-docs)
  • Access to n8n (or the script host) for the workflow you are documenting
  • Credentials / webhook URLs (store secrets outside the docs)

Browse Existing Workflows​

  1. Open Projects → Workflow → Workflows in the sidebar
  2. Start from the Workflows index
  3. Open a workflow page for purpose, trigger, steps, and integrations

Add a New Workflow Doc​

  1. Copy the template:
cp docs/ai-workflow/workflows/workflow-template.md \
docs/ai-workflow/workflows/your-workflow-name.md
  1. Fill in purpose, trigger, steps, APIs, and ownership notes
  2. Add the page under Workflow → Workflows in sidebars.js
  3. Add a short entry to docs/ai-workflow/workflows/index.md

Naming Conventions​

ItemConvention
Sidebar projectWorkflow
File namekebab-case.md
Page titleFull workflow name
Sidebar labelShort name (optional)

Next Steps​