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
- Open Projects → Workflow → Workflows in the sidebar
- Start from the Workflows index
- Open a workflow page for purpose, trigger, steps, and integrations
Add a New Workflow Doc
- Copy the template:
cp docs/ai-workflow/workflows/workflow-template.md \
docs/ai-workflow/workflows/your-workflow-name.md
- Fill in purpose, trigger, steps, APIs, and ownership notes
- Add the page under
Workflow→Workflowsinsidebars.js - Add a short entry to
docs/ai-workflow/workflows/index.md
Naming Conventions
| Item | Convention |
|---|---|
| Sidebar project | Workflow |
| File name | kebab-case.md |
| Page title | Full workflow name |
| Sidebar label | Short name (optional) |