chore(docs): remove remaining yml references from docs #1492
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Greptile Overview
Summary
This PR systematically removes all remaining YAML workflow documentation from the Sim platform as part of a documentation cleanup effort. The changes delete 17 comprehensive YAML documentation files from the `/docs/content/docs/en/yaml/` directory, including schema references, block documentation, examples, and configuration guides that totaled over 3,000 lines of technical content.The removed documentation covered all major workflow components including blocks (Agent, API, Condition, Evaluator, Function, Loop, Parallel, Response, Router, Starter, Webhook, Workflow), examples, and reference materials. This cleanup aligns with Sim's apparent strategic shift away from YAML-based workflow configuration toward the visual block-based interface built with ReactFlow that is emphasized throughout the remaining documentation.
The changes also include a minor modification to the API trigger documentation (apps/docs/content/docs/en/triggers/api.mdx) that removes a small YAML code snippet example, replacing detailed parameter format examples with a simple conceptual explanation. This maintains consistency with the broader effort to eliminate YAML references while preserving the core understanding of API trigger functionality.
This documentation refactoring suggests that Sim has fully transitioned to a visual, UI-driven workflow creation approach, making the parallel YAML documentation redundant and potentially confusing for users. The cleanup ensures documentation consistency and prevents users from attempting to use deprecated configuration methods.
Important Files Changed
Changed Files
| Filename | Score | Overview |
|---|---|---|
| apps/docs/content/docs/en/yaml/blocks/router.mdx | 5/5 | Complete deletion of YAML Router block schema documentation |
| apps/docs/content/docs/en/yaml/blocks/response.mdx | 4/5 | Complete removal of 238 lines of YAML Response block documentation |
| apps/docs/content/docs/en/yaml/blocks/workflow.mdx | 4/5 | Complete deletion of comprehensive YAML Workflow block documentation |
| apps/docs/content/docs/en/yaml/blocks/condition.mdx | 4/5 | Removal of 165 lines of YAML Condition block schema and examples |
| apps/docs/content/docs/en/blocks/agent.mdx | 4/5 | Replaced detailed YAML example with simple Memory block reference link |
| apps/docs/content/docs/en/yaml/blocks/parallel.mdx | 3/5 | Complete removal of 312 lines of YAML Parallel block documentation |
| apps/docs/content/docs/en/yaml/blocks/evaluator.mdx | 5/5 | Complete deletion of 255 lines of YAML Evaluator block documentation |
| apps/docs/content/docs/en/yaml/index.mdx | 4/5 | Removal of 159 lines of comprehensive YAML workflow reference documentation |
| apps/docs/content/docs/en/yaml/examples.mdx | 3/5 | Complete deletion of 273 lines of practical YAML workflow examples |
| apps/docs/content/docs/en/triggers/api.mdx | 4/5 | Removed YAML parameter format code example from API trigger docs |
| apps/docs/content/docs/en/yaml/blocks/function.mdx | 4/5 | Complete removal of 162 lines of YAML Function block documentation |
| apps/docs/content/docs/en/yaml/blocks/agent.mdx | 4/5 | Deletion of 218 lines of comprehensive YAML Agent block documentation |
| apps/docs/content/docs/en/yaml/blocks/index.mdx | 2/5 | Complete removal of 151 lines of YAML blocks index without replacement |
| apps/docs/content/docs/en/yaml/blocks/webhook.mdx | 4/5 | Deletion of 403 lines of comprehensive YAML webhook documentation |
| apps/docs/content/docs/en/yaml/block-reference.mdx | 4/5 | Removal of 238 lines of block reference syntax documentation |
| apps/docs/content/docs/en/yaml/blocks/api.mdx | 5/5 | Complete deletion of 431 lines of YAML API block documentation |
| apps/docs/content/docs/en/yaml/blocks/starter.mdx | 4/5 | Removal of 183 lines of YAML Starter block documentation |
Confidence score: 4/5
- This PR is safe to merge with moderate risk as it only removes documentation without affecting application functionality
- Score reflects the systematic nature of documentation cleanup, though removing extensive technical content without replacement creates potential gaps for users
- Pay close attention to the complete removal of comprehensive examples and reference materials that may still be valuable for users transitioning from YAML workflows
Sequence Diagram
sequenceDiagram
participant User
participant "Documentation System" as Docs
participant "YAML Files" as YAML
User->>Docs: "Remove remaining yml references"
Docs->>YAML: "Clear all YAML block documentation"
YAML-->>Docs: "Files emptied"
Docs-->>User: "Documentation cleanup complete"
17 files reviewed, 1 comment
| Add an **Input Format** field for each parameter. Runtime output keys mirror the schema and are also available under `<api.input>`. | ||
|
|
||
| ```yaml | ||
| - type: string | ||
| name: userId | ||
| value: demo-user # optional manual test value | ||
| - type: number | ||
| name: maxTokens | ||
| ``` | ||
| Manual runs in the editor use the `value` column so you can test without sending a request. During execution the resolver populates both `<api.userId>` and `<api.input.userId>`. |
There was a problem hiding this comment.
style: After removing the YAML example, the text references specific field names (userId, maxTokens) that were only shown in the removed code block. Consider adding a brief inline example or updating the text to use generic field names for clarity.
Prompt To Fix With AI
This is a comment left during a code review.
Path: apps/docs/content/docs/en/triggers/api.mdx
Line: 25:27
Comment:
style: After removing the YAML example, the text references specific field names (`userId`, `maxTokens`) that were only shown in the removed code block. Consider adding a brief inline example or updating the text to use generic field names for clarity.
How can I resolve this? If you propose a fix, please make it concise.
Summary
remove remaining yml references from docs
Type of Change
Testing
N/A
Checklist