Skip to content

docs(TSP-1227): add documentation for filesystem sync triggers#613

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1227
Open

docs(TSP-1227): add documentation for filesystem sync triggers#613
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1227

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented May 12, 2026

Summary

  • Creates a new page at build/agents/build-your-agent/agent-triggers/filesystem-sync.mdx documenting the filesystem sync trigger type
  • Covers watched volumes (shared memory vs personal files), glob pattern filtering, 100KB content limit, conversation threading, and access controls
  • Updates triggers.mdx overview to include filesystem sync in the trigger types section and decision table
  • Updates docs.json navigation to add the new page under Trigger Types

References

Create a new page for filesystem sync triggers explaining how file writes
to project memory or personal files volumes automatically trigger agents,
including glob pattern filtering, 100KB content limit, conversation
threading behavior, and access controls.

Update triggers.mdx overview and docs.json navigation to include the
new trigger type.

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

linear Bot commented May 12, 2026

TSP-1227

@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 3 files (1 with issues, 1 clean, 1 nav-only)

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 filesystem-sync.mdx uses lowercase "agent" and "trigger" throughout prose and one accordion title, while triggers.mdx correctly capitalizes both as Relevance AI product features. Six instances total.
🟢 Technical clarity 9/10 Non-obvious behavior (thread continuation per file, 100KB truncation, write ownership scoping) is all called out. UI references are specific.
🟢 Non-technical clarity 9/10 Both pages are well-structured with clear plain-English intros. No jargon dumps.
🟡 Structure 8/10 Setup steps in filesystem-sync.mdx use a plain numbered list where <Steps> would add visual progress indicators. Minor.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. Scores are a single overall judgment about the whole PR.

Overall vibe: The new filesystem-sync.mdx page is genuinely useful — it surfaces non-obvious constraints (the 100KB cap, the thread-continuation behavior, write ownership) clearly and concisely. The main problem is inconsistent capitalization of "Agent" and "Trigger" in the new file; triggers.mdx gets this right throughout, making the inconsistency easy to spot and fix.

🔧 Issues (6)
  • build/agents/build-your-agent/agent-triggers/filesystem-sync.mdx:7 — "a designated agent" → "a designated Agent" (product feature noun)
  • build/agents/build-your-agent/agent-triggers/filesystem-sync.mdx:11 — "the trigger fires and sends the following to your agent" → "the Trigger fires and sends the following to your Agent"
  • build/agents/build-your-agent/agent-triggers/filesystem-sync.mdx:20 — "Navigate to your agent and click Triggers" → "Navigate to your Agent and click Triggers"
  • build/agents/build-your-agent/agent-triggers/filesystem-sync.mdx:49 — "the user who created the sync trigger cause the sync to fire" → "the sync Trigger" (the noun refers to the product feature; the verb "cause the sync to fire" is fine as-is)
  • build/agents/build-your-agent/agent-triggers/filesystem-sync.mdx:64 — accordion title "Can I watch both volumes with a single trigger?" → "…with a single Trigger?" (noun referencing the product feature)
  • build/agents/build-your-agent/agent-triggers/filesystem-sync.mdx:65 — "Each filesystem sync trigger watches one volume." → "Each filesystem sync Trigger watches one volume."
🧩 Component suggestions (1)
  • build/agents/build-your-agent/agent-triggers/filesystem-sync.mdx:20–27 — the six setup steps are a plain numbered list. Replace with <Steps> for visual progress indicators, consistent with Mintlify best practice for sequential procedures. Note: sibling pages (tools-as-triggers.mdx, scheduled-triggers.mdx) also use plain lists here, so this is a low-priority suggestion rather than a blocker.
✅ Clean files (2)

build/agents/build-your-agent/triggers.mdx — no issues. Capitalization of Agent/Trigger is consistent throughout, including in the new filesystem sync section and FAQ. Links to the new filesystem-sync page resolve correctly.

docs.json — navigation entry for filesystem-sync is placed correctly in the agent-triggers group.

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

Files read: filesystem-sync.mdx (71 lines), triggers.mdx (127 lines), scheduled-triggers.mdx (60 lines, partial), tools-as-triggers.mdx (42 lines), docs.json (~40 lines, targeted grep)

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.

0 participants