Skip to content

Commit

Permalink
Add documentation for VSCode welcome page and activity bar
Browse files Browse the repository at this point in the history
Signed-off-by: Sanyam Agrawal <s51.agrawal@samsung.com>
  • Loading branch information
vivek-ellur committed Oct 15, 2024
1 parent bb1fd9b commit 7a65193
Show file tree
Hide file tree
Showing 20 changed files with 118 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/application/toc_all.md
Original file line number Diff line number Diff line change
Expand Up @@ -1167,13 +1167,14 @@
## Visual Studio Code Extension for Tizen
### [Prerequisites](/application/vscode-ext/index.md)
### [Installing Visual Studio Code Extension for Tizen](/application/vscode-ext/Tizen/dotnet.md)
### [Tizen Welcome Page](/application/vscode-ext/tools/welcome-page.md)
### [Tizen Activity Bar](/application/vscode-ext/tools/activity-bar.md)
### Tools
#### [Profiler](/application/vscode-ext/tools/profiler-user-manual.md)
#### [Memory Profiler](/application/vscode-ext/tools/memory-profiler-user-manual.md)
#### [Address Sanitizer](/application/vscode-ext/tools/address-sanitizer-user-manual.md)
#### [Leak Sanitizer](/application/vscode-ext/tools/leak-sanitizer-user-manual.md)
#### [UTC and Code Coverage](/application/vscode-ext/tools/unit-test-code-coverage-user-manual.md)
### Tizen
#### [Hybrid application development](/application/vscode-ext/Tizen/hybrid.md)
#### [RPK Application Development](/application/vscode-ext/Tizen/rpk.md)
### [Tizen Web](/application/vscode-ext/web.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/application/vscode-ext/Tizen/dotnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To install VS Code Extension for Tizen from the Visual Studio Code Marketplace:
2. In the **Extensions** view's **Search Extensions in Marketplace** field, enter **Tizen**.
3. Locate **Visual Studio Code Extension for Tizen** in the search results and click **Install**.
4. After the installation is complete, activate the extension by clicking **Reload**.
5. Once the extension has been activated, it asks whether you want to use an existing Tizen Baseline SDK installation or install a new one:
5. Once the extension has been activated, it asks whether you want to use an existing Tizen Baseline SDK installation or install a new one. Alternatively, you can use the GUI to perform the same task. Click [here](../tools/welcome-page.md#install-tizen-sdk) to access the GUI.

![Visual Studio Code Marketplace](media/vscode_baselinesdk_exists.png)

Expand Down
49 changes: 49 additions & 0 deletions docs/application/vscode-ext/tools/activity-bar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Tizen Activity Bar and Sidebar Feature

The new Tizen Activity Bar and Sidebar features offer a suite of powerful tools and functionalities designed to streamline your workflow, boost productivity, and make coding more intuitive than ever before.

The sidebar contains following features: [Welcome](#welcome-page), [Tizen Tools](#tizen-tools), [Actions](#actions), [Connected Devices](#connected-devices), [Report Platform Bug](#report-platform-bug)

### Welcome Page
- Please refer to the [Welcome](welcome-page.md#open-welcome-page) Section for an introduction to the Tizen Extension for VS Code.

![Activity Bar Contents](media/welcome-page2.png)

### Tizen Tools
- The Tizen Tools section contains following tools for Tizen development:

1. [**Tizen Emulator Manager**](../../tizen-studio/common-tools/emulator.md): The Tizen Emulator Manager allows you to create and manage emulator instances.

2. [**Device Manager**](../../tizen-studio/common-tools/device-manager.md): The Device Manager allows you to connect your device and manage it.

3. [**Certificate Manager**](../../tizen-studio/common-tools/certificate-registration.md): The Certificate Manager allows you to create and manage certificates.

4. [**Package Manager**](../../tizen-studio/setup/advanced-configuration.md): The Package Manager allows you to install, update, and remove Tizen Studio packages.


To **access these tools**, click on the **respective icons** in the **Tizen Tools section**. Each tool will open separately, providing you with the necessary functionalities for efficient Tizen development.

### Actions
- The Actions section includes various **commands** to streamline your Tizen project workflow:

1. **New Project**: Initiates the creation of a new Tizen project.

2. **Build Project**: Compiles the source code and generates output of your Tizen project.

3. **Run Project**: Executes the built project on a target device or emulator.

4. **Debug Project**: Launches the Tizen project in debug mode, allowing you to set breakpoints and analyze the code execution.

5. **Open Profiler**: Opens the Tizen Profiler, which helps in analyzing performance metrics and optimizing your application.

**Click** on the desired **action** to perform the corresponding operation on your Tizen project.

### Connected Devices
- The Connected Devices section displays a list of all connected Tizen devices. This allows you to select a specific device for running or debugging your Tizen project.

- To **view** the connected devices, **navigate** to the **Connected Devices** section.

### Report Platform Bug
- If you encounter any **issues or bugs** while using the Tizen Extension for VS Code, you can use the **Report Platform Bug** feature to report them.

- To report a **bug**, click on the **Report Platform Bug** button and provide the necessary **details** about the issue you encountered.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 66 additions & 0 deletions docs/application/vscode-ext/tools/welcome-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Welcome Page: Tizen Extension for VS Code

### Open Welcome Page
- Click on the **Tizen Extension icon** present in **Activity Bar**.

![Click Tizen Extension](media/activity-bar.png)

Select **Open Welcome Page** from the sidebar.

![Click Open Welcome Page](media/open-welcome-page.png)

The Welcome page will open in a new tab.

![Show Welcome Page](media/welcome-page.png)

### Install Tizen SDK

- Click on **Setup Tizen Studio** to launch Tizen **SDK Install Wizard** in a new tab.

![Click Setup Tizen Studio](media/installation-wizard.png)

To install **new Tizen SDK**, select **Install new Tizen SDK**.

![Select Install new Tizen SDK](media/install-tizen-sdk.png)

Accept the license agreement by clicking **I Agree**.

![Select I Agree](media/i-agree.png)

Choose an **empty folder** to install the Tizen SDK.

![Select Folder](media/select-folder.png)

The installation process will begin.

![Installation Started](media/installation-started.png)

### Use Existing Tizen Baseline SDK

- To use an **existing Tizen SDK**, select **Use Installed Tizen SDK**.

![Use Installed Tizen SDK](media/use-installed-sdk.png)

Select the **path** where the **Tizen SDK is installed**.

![Select Tizen SDK Path](media/select-sdk-path.png)

A **pop-up** will confirm if the Tizen SDK is **set** correctly.

![SDK Set Properly](media/sdk-set-properly.png)

- For more information about **Tizen Native/Web/Dotnet app development**, click here.

![Click more information](media/more-information.png)

A new page will be opened in default browser.

![Information Page](media/information-page.png)

- For more information about **Tizen SDK and its features**, click here.

![Click more about Tizen SDK](media/more-about-sdk.png)

The Tizen documentation page will be opened in the default browser.

![Documentation page](media/documentation-page.png)

0 comments on commit 7a65193

Please sign in to comment.