improvement(docs): add quick reference page and update SDK documentation

[waleedlatif1]

Summary

• Add Quick Reference docs page with common actions for workflows, blocks, canvas, deployment, variables, credentials
• Add missing keyboard shortcuts (Mod+Shift+F for fit to view, Mod+Shift+Enter for accept copilot changes)
• Update Python and TypeScript SDK READMEs with new methods (retry, rate limits, async execution)
• Fix TOC popover visibility on tablet screens

Type of Change

• Documentation update
• Bug fix

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]

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

Project	Deployment	Review	Updated (UTC)
docs	Ready	Preview, Comment	Jan 25, 2026 10:14am

[greptile-apps]

Greptile Overview

Greptile Summary

This PR enhances the documentation with a new Quick Reference page and updates SDK documentation to reflect the recently changed API interface.

Key Changes:

• Added comprehensive Quick Reference page (apps/docs/content/docs/en/quick-reference/index.mdx) with action tables for workspaces, workflows, blocks, canvas navigation, deployment, variables, and credentials - providing users with a centralized lookup for common tasks
• Updated Python and TypeScript SDK READMEs to document the new interface where input is now a separate parameter (previously input_data in options), and added documentation for new methods: get_job_status(), execute_with_retry(), get_rate_limit_info(), and get_usage_limits()
• Added two keyboard shortcuts to the shortcuts page: Mod+Shift+F for fit to view and Mod+Shift+Enter for accepting Copilot changes
• Fixed TOC popover visibility on tablet screens (768px-1279px) by adding targeted CSS media query to hide it on medium screens while keeping it visible on mobile and desktop
• Integrated the new quick-reference page into the documentation navigation after the getting-started page

Verification:
The SDK documentation changes were verified against the actual implementation code (packages/python-sdk/simstudio/__init__.py and packages/ts-sdk/src/index.ts) and accurately reflect the current SDK interfaces and available methods.

Impact:
Improves developer experience by providing better documentation coverage and fixes a UI bug on tablet devices. All changes are non-breaking and purely additive to the documentation.

Confidence Score: 5/5

• This PR is safe to merge with no risk - all changes are documentation-only updates that accurately reflect existing SDK implementations and improve user experience
• Score of 5 reflects that this is purely documentation work with no code changes to the SDKs themselves. The README updates accurately match the actual SDK implementations (verified by reading the source code). The new quick reference page provides valuable user guidance with well-structured tables. The CSS fix for TOC popover is targeted and scoped appropriately. The keyboard shortcuts additions are straightforward and consistent with existing patterns.
• No files require special attention - all documentation changes are accurate and well-structured

Important Files Changed

Filename	Overview
apps/docs/content/docs/en/quick-reference/index.mdx	New quick reference page added with comprehensive tables of common actions for workspaces, workflows, blocks, canvas, deployment, variables, and credentials
apps/docs/content/docs/en/keyboard-shortcuts/index.mdx	Added two new keyboard shortcuts: Mod+Shift+F for fit to view and Mod+Shift+Enter for accepting Copilot changes
apps/docs/app/global.css	Added CSS media query to hide TOC popover on tablet screens (768px-1279px) while keeping it visible on mobile and desktop
apps/docs/content/docs/en/meta.json	Added quick-reference page to navigation after getting-started page
packages/python-sdk/README.md	Updated documentation to reflect new SDK interface: changed input_data parameter to input, added new methods (get_job_status, execute_with_retry, get_rate_limit_info, get_usage_limits), and updated all code examples
packages/ts-sdk/README.md	Updated documentation to reflect new SDK interface: moved input parameter from options object to separate parameter, added new methods (get_job_status, execute_with_retry, get_rate_limit_info, get_usage_limits), and updated all code examples

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Docs as Documentation Site
    participant SDK as SDK (Python/TypeScript)
    participant API as Sim API

    Note over Dev,API: Documentation Enhancement Flow

    Dev->>Docs: Add Quick Reference Page
    Note right of Docs: Comprehensive action tables<br/>for common tasks
    
    Dev->>Docs: Update Keyboard Shortcuts
    Note right of Docs: Add Mod+Shift+F (fit to view)<br/>Add Mod+Shift+Enter (accept copilot)
    
    Dev->>Docs: Fix TOC Popover Display
    Note right of Docs: Hide on tablet (768px-1279px)<br/>Improve UX on medium screens
    
    Dev->>SDK: Update SDK Documentation
    Note right of SDK: New parameter signatures<br/>input (not input_data)<br/>Add retry, rate limits, async
    
    Dev->>Docs: Update Navigation
    Note right of Docs: Add quick-reference to meta.json
    
    Note over Dev,API: User Workflow with Updated Docs
    
    Dev->>Docs: Read Quick Reference
    Docs-->>Dev: Common actions & shortcuts
    
    Dev->>SDK: Use execute_workflow(input)
    SDK->>API: POST /api/workflows/:id/execute
    API-->>SDK: WorkflowExecutionResult
    SDK-->>Dev: Result with output
    
    Dev->>SDK: Check rate limits
    SDK-->>Dev: RateLimitInfo
    
    Dev->>SDK: Retry on rate limit
    SDK->>API: Retry with backoff
    API-->>SDK: Success after retry
    SDK-->>Dev: WorkflowExecutionResult

Loading

[greptile-apps]

_{No files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}