chore(docs): update docs

[waleedlatif1]

Summary

updated docs to reflect repo name

Type of Change

• Documentation

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]

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

Project	Deployment	Preview	Comments	Updated (UTC)
docs	Building	Preview	Comment	Oct 8, 2025 7:55am
sim	Building	Preview	Comment	Oct 8, 2025 7:55am

[greptile-apps]

Greptile Overview

Summary

This PR updates documentation references across the codebase to reflect a repository name change from 'simstudio/sim' to 'simstudioai/sim'. The changes primarily affect GitHub workflow files that generate release notes for the Python and TypeScript SDKs, ensuring that automated release documentation contains accurate repository URLs and enhanced documentation links.

The PR also includes a significant change to the TypeScript SDK package configuration, converting it from a dual-mode (CommonJS/ESM) package to ESM-only by removing the 'require' field from the exports configuration. This aligns with the existing "type": "module" declaration and modernizes the package structure, though it represents a breaking change for CommonJS consumers.

These changes integrate with the existing CI/CD infrastructure by ensuring that when the publish-python-sdk.yml and publish-ts-sdk.yml workflows create GitHub releases, the release notes will contain correct repository references and comprehensive documentation links pointing to both the GitHub README and the hosted documentation site at docs.sim.ai.

Important Files Changed

Changed Files

Filename	Score	Overview
.github/workflows/publish-python-sdk.yml	5/5	Updated repository URL from 'simstudio/sim' to 'simstudioai/sim' and added docs.sim.ai link in release notes template
.github/workflows/publish-ts-sdk.yml	5/5	Updated repository URL from 'simstudio/sim' to 'simstudioai/sim' and enhanced documentation references in workflow
packages/ts-sdk/package.json	3/5	Removed 'require' field from exports, converting package to ESM-only which is a breaking change for CommonJS users

Confidence score: 4/5

• This PR is generally safe to merge with minimal risk, though one file contains a breaking change
• Score reflects straightforward documentation updates but is lowered due to the breaking change in the TypeScript SDK package configuration
• Pay close attention to packages/ts-sdk/package.json as it removes CommonJS support and may affect downstream consumers

Sequence Diagram

sequenceDiagram
    participant Developer
    participant GitHub
    participant GitHubActions as "GitHub Actions"
    participant PyPI
    participant NPM
    participant TestRunner as "Test Runner"
    participant Builder
    participant Registry as "Package Registry"

    Developer->>GitHub: "Push to main branch (packages/python-sdk/**)"
    GitHub->>GitHubActions: "Trigger publish-python-sdk workflow"
    GitHubActions->>GitHubActions: "Checkout repository"
    GitHubActions->>GitHubActions: "Setup Python 3.12"
    GitHubActions->>GitHubActions: "Install build dependencies"
    GitHubActions->>TestRunner: "Run pytest tests"
    TestRunner-->>GitHubActions: "Test results"
    GitHubActions->>GitHubActions: "Get package version from pyproject.toml"
    GitHubActions->>PyPI: "Check if version exists"
    PyPI-->>GitHubActions: "Version check result"
    alt Version doesn't exist
        GitHubActions->>Builder: "Build package"
        Builder-->>GitHubActions: "Package built"
        GitHubActions->>GitHubActions: "Check package with twine"
        GitHubActions->>PyPI: "Publish to PyPI"
        PyPI-->>GitHubActions: "Publish success"
        GitHubActions->>GitHub: "Create GitHub Release"
    else Version exists
        GitHubActions->>GitHubActions: "Log skipped publish"
    end

    Developer->>GitHub: "Push to main branch (packages/ts-sdk/**)"
    GitHub->>GitHubActions: "Trigger publish-ts-sdk workflow"
    GitHubActions->>GitHubActions: "Checkout repository"
    GitHubActions->>GitHubActions: "Setup Bun & Node.js"
    GitHubActions->>GitHubActions: "Install dependencies"
    GitHubActions->>TestRunner: "Run bun test"
    TestRunner-->>GitHubActions: "Test results"
    GitHubActions->>Builder: "Build package"
    Builder-->>GitHubActions: "Package built"
    GitHubActions->>GitHubActions: "Get package version from package.json"
    GitHubActions->>NPM: "Check if version exists"
    NPM-->>GitHubActions: "Version check result"
    alt Version doesn't exist
        GitHubActions->>NPM: "Publish to npm"
        NPM-->>GitHubActions: "Publish success"
        GitHubActions->>GitHub: "Create GitHub Release"
    else Version exists
        GitHubActions->>GitHubActions: "Log skipped publish"
    end

Loading

_{3 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}