diff --git a/code-studio-toc.html b/code-studio-toc.html index a403640..2430e77 100644 --- a/code-studio-toc.html +++ b/code-studio-toc.html @@ -3,18 +3,34 @@
  • Getting Started +
    • +
  • Tutorial + +
  • Enterprise Servers
    • +
  • How to Guides + +
  • Features
    • - + \ No newline at end of file diff --git a/code-studio/getting-started/feature-summary.md b/code-studio/getting-started/overview.md similarity index 100% rename from code-studio/getting-started/feature-summary.md rename to code-studio/getting-started/overview.md diff --git a/code-studio/how-to-guides/Configure-default-model.md b/code-studio/how-to-guides/Configure-default-model.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/how-to-guides/add-BYOK-model.md b/code-studio/how-to-guides/add-BYOK-model.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/how-to-guides/add-local-model.md b/code-studio/how-to-guides/add-local-model.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/how-to-guides/budget-alert.md b/code-studio/how-to-guides/budget-alert.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/how-to-guides/buy-more-credits.md b/code-studio/how-to-guides/buy-more-credits.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/how-to-guides/daily-cost-usage.md b/code-studio/how-to-guides/daily-cost-usage.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/how-to-guides/invite-new-user.md b/code-studio/how-to-guides/invite-new-user.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/how-to-guides/manage-chat-session.md b/code-studio/how-to-guides/manage-chat-session.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/how-to-guides/quick-fix-error.md b/code-studio/how-to-guides/quick-fix-error.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/security.md b/code-studio/security.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/troubleshoot/Troubleshoot-images/Openrouter-home.png b/code-studio/troubleshoot/Troubleshoot-images/Openrouter-home.png deleted file mode 100644 index 59212d8..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/Openrouter-home.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/Openrouter-integrations.png b/code-studio/troubleshoot/Troubleshoot-images/Openrouter-integrations.png deleted file mode 100644 index 62bd792..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/Openrouter-integrations.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/Openrouter-key.png b/code-studio/troubleshoot/Troubleshoot-images/Openrouter-key.png deleted file mode 100644 index d4cd03e..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/Openrouter-key.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/Openrouter-setting.png b/code-studio/troubleshoot/Troubleshoot-images/Openrouter-setting.png deleted file mode 100644 index 9ae982f..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/Openrouter-setting.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/confignameadded.png b/code-studio/troubleshoot/Troubleshoot-images/confignameadded.png deleted file mode 100644 index 5c1ca73..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/confignameadded.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/confignamemissing.png b/code-studio/troubleshoot/Troubleshoot-images/confignamemissing.png deleted file mode 100644 index 1f7295e..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/confignamemissing.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/eaccess.png b/code-studio/troubleshoot/Troubleshoot-images/eaccess.png deleted file mode 100644 index 924eb88..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/eaccess.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/macdel-1.png b/code-studio/troubleshoot/Troubleshoot-images/macdel-1.png deleted file mode 100644 index 1977e67..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/macdel-1.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/macdel-2.png b/code-studio/troubleshoot/Troubleshoot-images/macdel-2.png deleted file mode 100644 index 67baf7b..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/macdel-2.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/macdel-3.png b/code-studio/troubleshoot/Troubleshoot-images/macdel-3.png deleted file mode 100644 index cab4b98..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/macdel-3.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/openconfig.png b/code-studio/troubleshoot/Troubleshoot-images/openconfig.png deleted file mode 100644 index 5cbf124..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/openconfig.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/windel1.png b/code-studio/troubleshoot/Troubleshoot-images/windel1.png deleted file mode 100644 index 7117f98..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/windel1.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/windel2.png b/code-studio/troubleshoot/Troubleshoot-images/windel2.png deleted file mode 100644 index 8743426..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/windel2.png and /dev/null differ diff --git a/code-studio/troubleshoot/Troubleshoot-images/windel3.png b/code-studio/troubleshoot/Troubleshoot-images/windel3.png deleted file mode 100644 index c47cdba..0000000 Binary files a/code-studio/troubleshoot/Troubleshoot-images/windel3.png and /dev/null differ diff --git a/code-studio/troubleshoot/access-session-history-files.md b/code-studio/troubleshoot/access-session-history-files.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/troubleshoot/enable-legacy-docs-indexing.md b/code-studio/troubleshoot/enable-legacy-docs-indexing.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/troubleshoot/how-to-remove-cache-folders-of-code-studio-to-resolve-the-app-corruption.md b/code-studio/troubleshoot/how-to-remove-cache-folders-of-code-studio-to-resolve-the-app-corruption.md index 59a66ea..39dd257 100644 --- a/code-studio/troubleshoot/how-to-remove-cache-folders-of-code-studio-to-resolve-the-app-corruption.md +++ b/code-studio/troubleshoot/how-to-remove-cache-folders-of-code-studio-to-resolve-the-app-corruption.md @@ -9,31 +9,3 @@ keywords: cache, corruption, troubleshoot # How to remove cache folders of Code Studio to resolve the app corruption. -This guide explains how to delete the Code Studio cache folders when you encounter application corruption issues. - -## Steps to Delete the Cache Folders - -### step 1: Delete the config.yaml file -### WINDOWS - -Delete the config.yaml file in this location "C:\Users\YourName\ .sfcodestudio\ .codestudio\config.yaml" - -cache - -### MAC -Delete the config.yaml file in this location "Users\syncfusion\ .sfcodestudio\ .codestudio\config.yaml" - -cache - -### step 2: Delete the Syncfusion Code Studio folders -### WINDOWS -Delete the Syncfusion Code Studio folder in these locations "C:\Program Files\Syncfusion Code Studio" and "C:\Users\YourName\AppData\Roaming\Syncfusion Code Studio" - -cache -cache - -### MAC -Delete the Syncfusion Code Studio folder in these locations "Users\syncfusion\Library\Application Support\Syncfusion Code Studio" and "Applications\Syncfusion Code Studio" - -cache -cache \ No newline at end of file diff --git a/code-studio/troubleshoot/migrate-agent-files.md b/code-studio/troubleshoot/migrate-agent-files.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/troubleshoot/migrate-code-studio-rules-to-instructions.md b/code-studio/troubleshoot/migrate-code-studio-rules-to-instructions.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/troubleshoot/migrate-legacy-prompt-files.md b/code-studio/troubleshoot/migrate-legacy-prompt-files.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/troubleshoot/openai-integration.md b/code-studio/troubleshoot/openai-integration.md index 0bf54f9..e326f89 100644 --- a/code-studio/troubleshoot/openai-integration.md +++ b/code-studio/troubleshoot/openai-integration.md @@ -8,88 +8,3 @@ keywords: O3, Openrouter, troubleshoot, code-studio, syncfusion # How to Resolve Error (Status Code 403) for O3 model in OpenAI Integration via OpenRouter -This guide will help you easily set up and use the OpenAI o3 model through OpenRouter’s platform with your own OpenAI API key. Follow these simple steps to get started and make the most of this powerful integration. - ---- - -## What You Need to Know - -- The OpenAI o3 model requires your own OpenAI API key (**Bring Your Own Key - BYOK**) to work with OpenRouter. -- You’ll need an OpenAI account and an OpenRouter account to proceed. - ---- - -## Prerequisites - -- An active OpenAI account with a valid API key (**Tier 3 or higher** is required for the o3 model). -- An OpenRouter account to connect and manage your API key. - ---- - -## Step-by-Step Setup - -### 1. Obtain an OpenAI API Key - -- **Log in to OpenAI** - - Visit [OpenAI Platform](https://platform.openai.com/) and sign in to your account. - -- **Generate an API Key** - - Navigate to the API keys section in the OpenAI dashboard. - - Click **Create API Key** and give it a descriptive name (e.g., `OpenRouter o3 Key`). - - Copy the generated key and store it securely. **Do not share it publicly.** - ---- - -### 2. Configure OpenRouter with Your OpenAI API Key - -- **Sign Up for OpenRouter** - - Go to [OpenRouter](https://openrouter.ai/) and create an account if you don’t already have one. - - Log in to your OpenRouter dashboard. - -- **Access OpenRouter Integrations** - - Navigate to [Settings > Integrations](https://openrouter.ai/settings/integrations) - - open config file - - - open config file - - - - Choose **OpenAI** as the provider for the o3 model. - - - open config file - - - Paste your OpenAI API key into the provided field. - - Make sure it’s a valid **Tier 3 or higher** key. - - open config file - - - Click **Save** to link your key to OpenRouter. The platform will verify your key and set it up for o3 model requests. - ---- - -## Monitor Your Usage - -- **Check Usage Limits:** Free accounts on OpenRouter have a limit of 50 requests per day. If you’ve purchased 10+ credits, this increases to 1,000 requests per day -- **Track Costs:** OpenRouter’s dashboard shows your token usage and costs based on your OpenAI API key activity. - - ---- - -## Best Practices - -- **Secure Your API Keys**: Never expose your OpenAI or OpenRouter API keys in public repositories. OpenRouter is a GitHub secret scanning partner to detect exposed keys. - -- **Error Handling:** Implement error handling for cases like “Forbidden” errors, which may indicate an invalid or insufficient-tier API key. - -- **Test the Integration:** After setup, test with a simple request to ensure your API key and configuration work correctly. If errors occur (e.g., “OpenAI is temporarily requiring a Tier 3 API key”), verify your OpenAI account tier. - ---- - -## Additional Resources - -- [OpenRouter Documentation](https://openrouter.ai/docs) – Detailed API specifications -- [OpenRouter Integrations](https://openrouter.ai/settings/integrations) – Manage API keys -- [OpenAI Dashboard](https://platform.openai.com/) – API key management and tier status -- [OpenRouter Model Details](https://openrouter.ai/docs#models) – Info on o3 and other models diff --git a/code-studio/troubleshoot/resolve-failed-to-parse-assistant.md b/code-studio/troubleshoot/resolve-failed-to-parse-assistant.md deleted file mode 100644 index 1243408..0000000 --- a/code-studio/troubleshoot/resolve-failed-to-parse-assistant.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Resolving Failed to Parse Assitant Issue -description: Fix the YAML configuration error by adding the required name field in Syncfusion Code Studio. -platform: syncfusion-code-studio -control: IDE -documentation: Troubleshoot -keywords: config, yaml, name, required, parse, error, assistant, code-studio, windows, macos ---- - -# Resolving the "Failed to parse assistant: name: Required" Error - -## Overview -When starting or using **Syncfusion Code Studio**, you may see an error dialog similar to: - -Failed to parse assistant: name: Required - -Config error - -This occurs when the `name` field is missing in the Code Studio configuration YAML file. This guide explains how to add the missing field and resolve the issue. - - - -## Prerequisites -- Syncfusion Code Studio installed. -- Ability to edit the configuration file from within Code Studio. - -## Steps to Resolve - -### Step 1: Open the Config File from Code Studio -1. In Code Studio, click the Gear (Settings) icon in the sidebar. -2. Select "Open Config". This opens the YAML configuration file. - -Config error - -### Step 2: Add the Required name Field -1. In the opened YAML file, add a `name` field for your local assistant and save the file. For example: - -```yaml -name: Local Assistant - -``` -Config error - - -> **Notes:** `name` must be a non-empty string and Keep YAML indentation consistent (use spaces, not tabs). - -### Step 3: Restart Code Studio -1. Close Syncfusion Code Studio. -2. Reopen it and verify the error is resolved. - diff --git a/code-studio/troubleshoot/resolve-mcp-server-eaccess-issue.md b/code-studio/troubleshoot/resolve-mcp-server-eaccess-issue.md deleted file mode 100644 index daf1dee..0000000 --- a/code-studio/troubleshoot/resolve-mcp-server-eaccess-issue.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Resolve MCP Server EACCESS Error -description: Steps to fix EACCESS permission errors when installing MCP servers from the Marketplace in Syncfusion Code Studio. -platform: syncfusion-code-studio -control: IDE -documentation: Troubleshoot -keywords: mcp, eaccess, permission, marketplace, macos, install, error, troubleshoot, code-studio ---- - - -# Resolving the EACCESS Error in Syncfusion Code Studio - -## Overview -When attempting to install the MCP server in the Marketplace tab of **Syncfusion Code Studio**, you may encounter an **EACCESS error**. This issue typically arises due to insufficient permissions in the application's support directory. This document provides a clear, step-by-step guide to resolve the issue professionally and efficiently. - - **Note:** The EACCESS error most commonly occurs on macOS systems. - -EACCESS ERROR - -## Prerequisites -- Administrative access to your system. -- A terminal application (e.g., Terminal on macOS). -- Syncfusion Code Studio installed on your system. - -## Steps to Resolve the EACCESS Error - -### Step 1: Change Ownership of the Directory -To ensure your user account has the necessary permissions, you need to change the ownership of the Syncfusion Code Studio directory. - -1. Open your terminal application. -2. Run the following command to change the ownership to your user account: - - ```bash - sudo chown -R $(whoami):staff ~/Library/Application\ Support/syncfusion.codestudio - ``` - -When prompted, enter your administrator password. -This command assigns ownership of the directory to your user account, ensuring proper access. - -### Step 2: Update Directory Permissions - 1. After changing ownership, update the permissions to grant full read and write access to the directory. - - - 2. In the terminal, run the following command: - -```bash -chmod -R u+rw ~/Library/Application\ Support/syncfusion.codestudio -``` - - - 3. This command ensures that your user account has read and write permissions for the directory and its contents. - - -### Step 3: Restart Syncfusion Code Studio -To apply the changes: - -1. Close Syncfusion Code Studio if it is currently open. -2. Reopen the application. -3. Navigate to the Marketplace tab and attempt to install the MCP server again to verify that the issue is resolved. \ No newline at end of file diff --git a/code-studio/troubleshoot/resolve-uncaught-exception-error.md b/code-studio/troubleshoot/resolve-uncaught-exception-error.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/troubleshoot/review-gitdiff-changes.md b/code-studio/troubleshoot/review-gitdiff-changes.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/troubleshoot/use-codebase-search.md b/code-studio/troubleshoot/use-codebase-search.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/troubleshoot/view-code-studio-token-usage.md b/code-studio/troubleshoot/view-code-studio-token-usage.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/tutorials/build-ui-using-syncfusionui-builder.md b/code-studio/tutorials/build-ui-using-syncfusionui-builder.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/tutorials/compare-ai-models.md b/code-studio/tutorials/compare-ai-models.md new file mode 100644 index 0000000..e69de29 diff --git a/code-studio/tutorials/generate-your-first-code-using-agent.md b/code-studio/tutorials/generate-your-first-code-using-agent.md new file mode 100644 index 0000000..e69de29