Skip to content

Conversation

@icecrasher321
Copy link
Collaborator

Summary

Some blocks had references to yaml syntax in best practices field.

Type of Change

  • Bug fix

Testing

N/A

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel
Copy link

vercel bot commented Dec 23, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Review Updated (UTC)
docs Skipped Skipped Dec 23, 2025 3:58am

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Dec 23, 2025

Greptile Summary

Removed outdated YAML syntax references from bestPractices fields across four block configuration files (agent, knowledge, memory, and schedule). This cleanup improves documentation accuracy by removing references to a deprecated configuration format.

Key changes:

  • Agent block: Removed mention of "YAML syntax" and outdated restrictions about not using core blocks as tools, replaced with clearer guidance about preferring integrations
  • Knowledge block: Removed "Search up examples with knowledge base blocks to understand YAML syntax" line
  • Memory block: Removed YAML syntax reference and improved guidance about when to use memory block vs agent block's native memory modes
  • Schedule block: Removed "Search up examples with schedule blocks to understand YAML syntax" line

All changes are documentation-only updates to the bestPractices string fields. No functional code changes were made.

Confidence Score: 5/5

  • This PR is safe to merge - it only updates documentation strings
  • All changes are limited to string literals in bestPractices fields with no functional code modifications, no runtime behavior changes, and improved documentation accuracy
  • No files require special attention

Important Files Changed

Filename Overview
apps/sim/blocks/blocks/agent.ts Removed YAML syntax references and outdated tool restrictions, replaced with clearer guidance about using integrations
apps/sim/blocks/blocks/knowledge.ts Removed YAML syntax reference from best practices
apps/sim/blocks/blocks/memory.ts Removed YAML syntax reference and clarified memory block usage guidance
apps/sim/blocks/blocks/schedule.ts Removed YAML syntax reference from best practices

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Agent as AgentBlock
    participant Knowledge as KnowledgeBlock
    participant Memory as MemoryBlock
    participant Schedule as ScheduleBlock
    participant User as End User

    Note over Dev,User: Documentation Update Flow
    
    Dev->>Agent: Remove YAML syntax references
    Dev->>Agent: Update tool usage guidance
    Note over Agent: bestPractices updated<br/>Old: "Check custom tools examples for YAML syntax"<br/>New: "Prefer using integrations as tools"
    
    Dev->>Knowledge: Remove YAML syntax references
    Note over Knowledge: bestPractices updated<br/>Removed: "Search up examples...YAML syntax"
    
    Dev->>Memory: Remove YAML syntax references
    Dev->>Memory: Clarify memory usage guidance
    Note over Memory: bestPractices updated<br/>Improved guidance on memory block vs agent memory modes
    
    Dev->>Schedule: Remove YAML syntax references
    Note over Schedule: bestPractices updated<br/>Removed: "Search up examples...YAML syntax"
    
    User->>Agent: View block documentation
    Agent-->>User: Shows updated best practices (no YAML references)
    
    User->>Memory: View block documentation
    Memory-->>User: Shows clarified usage guidance
Loading

@icecrasher321 icecrasher321 merged commit ccd92b9 into staging Dec 23, 2025
11 checks passed
@waleedlatif1 waleedlatif1 deleted the improvement/block-best-practices branch December 23, 2025 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants