Skip to content

feat(editor): added docs link to editor - #3116

Merged
waleedlatif1 merged 1 commit into
stagingfrom
feat/docs
Feb 2, 2026
Merged

feat(editor): added docs link to editor#3116
waleedlatif1 merged 1 commit into
stagingfrom
feat/docs

Conversation

@waleedlatif1

Copy link
Copy Markdown
Collaborator

Summary

  • added docs link to editor

Type of Change

  • New Feature

Testing

Tested manually

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

vercelBot commented Feb 2, 2026

Copy link
Copy Markdown

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

1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
docsSkippedSkippedFeb 2, 2026 8:13pm

Request Review

@greptile-apps

Copy link
Copy Markdown
Contributor

Greptile Overview

Greptile Summary

Made the documentation button always visible in the editor header with a fallback to the quick reference page when block-specific documentation is not available. This improves discoverability by ensuring users always have access to documentation.

Key improvements:

  • Docs button now always visible (previously conditional on docsLink existence)
  • Added fallback to https://docs.sim.ai/quick-reference when block lacks specific docs
  • Improved ref pattern from useRef + useEffect to useCallback ref for auto-selecting rename input
  • Extracted repeated dashed divider style to DASHED_DIVIDER_STYLE constant
  • Wrapped advancedValuesPresent in useMemo for performance optimization
  • Cleaned up unnecessary inline comments

Confidence Score: 4/5

  • Safe to merge with minor consideration for UX consistency
  • Changes are well-implemented with good React patterns (callback refs, memoization, constant extraction). The always-visible docs button with fallback URL improves user experience, though it's worth verifying this aligns with product requirements for blocks without specific documentation
  • No files require special attention

Important Files Changed

FilenameOverview
apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/editor.tsxMade docs button always visible with fallback URL, improved ref handling with callback pattern, extracted repeated styles to constant, added memoization for performance

Sequence Diagram

sequenceDiagram
participant User
participant Editor
participant Browser
participant Docs
User->>Editor: Click docs button (BookOpen icon)
Editor->>Editor: handleOpenDocs()
alt Block has specific docsLink
Editor->>Browser: window.open(blockConfig.docsLink)
Browser->>Docs: Navigate to specific block docs
else No specific docsLink
Editor->>Browser: window.open('https://docs.sim.ai/quick-reference')
Browser->>Docs: Navigate to quick reference page
end
Docs-->>User: Display documentation
Loading

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

@waleedlatif1
waleedlatif1 merged commit a9b7d75 into stagingFeb 2, 2026
12 checks passed
@waleedlatif1
waleedlatif1 deleted the feat/docs branch February 2, 2026 20:22
royceP2 pushed a commit to arenadeveloper02/p2-sim that referenced this pull request Mar 3, 2026
Sign up for freeto 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.

1 participant

@waleedlatif1