Skip to content

docs(TSP-1245): add filesystem sync trigger documentation#631

Closed
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1245
Closed

docs(TSP-1245): add filesystem sync trigger documentation#631
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1245

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented May 19, 2026

Summary

  • Adds Filesystem sync triggers as a new trigger type in add-triggers.mdx — overview paragraph, use-case bullets, and a numbered configuration walkthrough with glob pattern examples
  • Adds the filesystem sync trigger entry to the types list in trigger-to-agent-configuration.mdx

Changes

  • build/workforces/build-an-ai-workforce/add-triggers.mdx: new #### Filesystem sync triggers section in Types of Triggers; new ### Filesystem sync trigger configuration section with step-by-step setup and glob pattern examples
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx: new bullet for Filesystem Sync Triggers in the Types of Triggers list

Linear issue

https://linear.app/relevance/issue/TSP-1245/

Add filesystem sync trigger type to the triggers overview and configuration
sections, and add a brief description to the trigger-to-agent-configuration
types list.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label May 19, 2026
@linear
Copy link
Copy Markdown

linear Bot commented May 19, 2026

TSP-1245

@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 2 files (2 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🔴 Consistency 4/10 Pervasive title-case heading violations across both files (15+ headings). One banned word (seamlessly). Four internal links use full https://relevanceai.com/docs/... URLs instead of root-relative paths. The newly added filesystem sync sections actually use correct sentence case, which throws the inconsistency with surrounding headings into sharp relief.
🟡 Technical clarity 7/10 Cron reference table and examples are genuinely useful. Step 1 in "Adding additional Triggers" ("Navigate to the Workforce interface") is too vague. Four links in the FAQ accordion use absolute URLs that will break if the site ever moves.
🟡 Non-technical clarity 8/10 Both pages explain trigger types clearly before diving into configuration. Good use-case bullets under each trigger type. The "Trigger to Agent configuration" page could define what a "connection" means before listing configuration options — the concept isn't defined, just configured.
🟡 Structure 7/10 add-triggers.mdx ends with FAQ accordions and no CTA — there's nowhere obvious to go next. Sequential numbered steps throughout both files would benefit from <Steps>. The two inline examples in trigger-to-agent-configuration.mdx interrupt reading flow and belong in accordions.

Overall vibe: Both pages cover the material thoroughly — the cron expression reference is excellent and the trigger-type breakdowns are clear and useful. The main drag is a near-blanket failure to apply sentence case to headings; this is a consistent style problem across both files that needs a pass before merge.

🔧 Issues (28)

Banned words

  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:125seamlessly is a banned word: "works seamlessly with other Workforce Builder components" → "works with other Workforce Builder components"

Heading sentence case — add-triggers.mdx

  • build/workforces/build-an-ai-workforce/add-triggers.mdx:59## Adding Triggers to Your Workforce## Adding Triggers to your Workforce ("Your" is not a proper noun)
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:61### Adding Your First Trigger### Adding your first Trigger
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:67### Adding Additional Triggers### Adding additional Triggers
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:82### Manual Trigger Configuration### Manual Trigger configuration
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:93### Integration Trigger Configuration### Integration Trigger configuration
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:103### Recurring Schedule Trigger Configuration### Recurring schedule Trigger configuration
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:107#### Simple Schedule Options#### Simple schedule options
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:116#### Advanced: Cron Expressions#### Advanced: Cron expressions
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:208## Best Practices for Using Triggers## Best practices for using Triggers
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:210### Strategic Trigger Placement### Strategic Trigger placement
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:214### Trigger Maintenance### Trigger maintenance
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:220### Recurring Schedule Best Practices### Recurring schedule best practices
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:229### Security Considerations### Security considerations
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:43,165 — Inconsistency introduced by this PR: the new #### Filesystem sync triggers and ### Filesystem sync trigger configuration headings correctly use sentence case, but the surrounding #### Manual Triggers, #### Integration Triggers, #### Recurring Schedule Triggers, #### External Triggers (Zapier), and their matching config headings do not. The new content is right; the old headings need to be updated to match.

Heading sentence case — trigger-to-agent-configuration.mdx

  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:2,4 — Frontmatter title and sidebarTitle both read 'Trigger to Agent Configuration''Trigger to Agent configuration' ("Configuration" is not a proper noun)
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:25## Setting Up a Trigger to Agent Connection## Setting up a Trigger to Agent connection
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:27### Basic Setup### Basic setup
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:33### Configuration Options### Configuration options
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:38#### Communication Settings#### Communication settings
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:45#### Behavior Settings#### Behavior settings
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:53#### Task Management#### Task management
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:61## Best Practices## Best practices
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:63### Effective Trigger to Agent Design### Effective Trigger to Agent design
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:71### Common Patterns### Common patterns
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:79### Example 1: Email Response Workflow### Example 1: Email response workflow
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:91### Example 2: Daily Report Generation### Example 2: Daily report generation
  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:123## Related Features## Related features

Internal link format

  • build/workforces/build-an-ai-workforce/add-triggers.mdx:268,283,285,287 — Four links inside the "How do I test my triggers?" accordion use full https://relevanceai.com/docs/... URLs. CLAUDE.md requires root-relative paths. Replace with /build/workforces/workforce-features/workforce-task-view, /get-started/core-concepts/tools, and /build/agents/build-your-agent/triggers.
🧩 Component suggestions (3)
  • build/workforces/build-an-ai-workforce/add-triggers.mdx:62–65,69–76,84–91,95–101,168–178 — All the numbered how-to steps throughout this page use plain markdown lists. These are sequential procedures and would benefit from <Steps> for visual progress indicators. At minimum apply it to the longer procedures like "Adding additional Triggers" (5 steps) and "Filesystem sync trigger configuration" (6 steps).

  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:28–32 — The 4-step "Basic Setup" procedure is a sequential walkthrough; wrap in <Steps> for consistent visual treatment.

  • build/workforces/workforce-features/trigger-to-agent-configuration.mdx:79–100 — The two inline examples (Email Response Workflow and Daily Report Generation) sit at the same visual weight as the surrounding reference content and interrupt the page flow. Wrap each in an <Accordion title="Example: email response workflow"> / <Accordion title="Example: daily report generation"> inside an <AccordionGroup> so readers can skip them.

🏗️ Page structure (1)
  • build/workforces/build-an-ai-workforce/add-triggers.mdx — No closing CTA. The page ends with the FAQ accordion group and leaves the reader nowhere to go. Add a ## What's next? with links to /build/workforces/workforce-features/trigger-to-agent-configuration (the natural next step after setting up a trigger) and /build/workforces/workforce-features/workforce-task-view (monitoring the results).
✅ Clean files (0)

Both files have issues.

🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 2
Total lines processed ~646

Files read: build/workforces/build-an-ai-workforce/add-triggers.mdx (294 lines), build/workforces/workforce-features/trigger-to-agent-configuration.mdx (130 lines), build/workforces/workforce-features/agent-to-agent-configuration.mdx (100 lines), build/agents/build-your-agent/triggers.mdx (122 lines)

@jordanc-relevanceai
Copy link
Copy Markdown
Collaborator

Consolidated into #655 (filesystem sync trigger docs, agents + workforces). Closing in favor of that PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants