Skip to content

Commit

Permalink
Merge pull request #18044 from unoplatform/dev/agzi/UpdateRiderPluginDoc
Browse files Browse the repository at this point in the history
Docs: Update Rider plugin documentation to prioritize version 2024.2 now that it is the current stable release of Rider IDE
  • Loading branch information
agneszitte authored Aug 27, 2024
2 parents c3e1971 + ee2d5bd commit ff2f3f2
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 31 deletions.
54 changes: 27 additions & 27 deletions doc/articles/create-an-app-rider.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,36 @@ uid: Uno.GettingStarted.CreateAnApp.Rider

> [!IMPORTANT]
>
> - **Rider (2024.1 and earlier)**: Current versions of Rider (2024.1 and earlier) do not support creating Uno Platform projects using the "New Solution" dialog, even if the Uno Platform project template appears.
> Make sure to follow the directions for **Rider 2024.1** provided below.
>
> - **Rider (2024.2 and above)**: For Rider (2024.2 and above), we have released a Preview version of the Uno Platform Plugin that supports creating Uno Platform projects using the "New Solution" dialog.
> Make sure to follow the directions for **Rider 2024.2** provided below.
>
> - **Rider (2024.1 and earlier)**: Current versions of Rider (2024.1 and earlier) do not support creating Uno Platform projects using the "New Solution" dialog, even if the Uno Platform project template appears.
> Make sure to follow the directions for **Rider 2024.1** provided below.
### [**Rider Version 2024.2+**](#tab/rider2024-2)

Creating an Uno Platform project is done by following these steps:

1. On the **Welcome to JetBrains Rider** screen, click **New Solution**.

![A screen showing the Welcome to JetBrains Rider screen](Assets/quick-start/rider-welcome-screen-new-solution.png)

1. From the project types list on the left, locate and click **Uno Platform App**. It will be under the **Uno Platform** section.
1. Configure your new project by providing a solution name and a directory location.
1. Choose a template to build your application.

![A screen showing the Uno Platform App Template](Assets/quick-start/rider-configure-new-unoplatform-app.png)

> [!TIP]
> For a detailed overview of the Uno Platform project wizard and all its options, see the [Wizard guide](xref:Uno.GettingStarted.UsingWizard).
1. Click the create button and wait for the solution to load.

1. You should now have a folder structure that looks like this:

![A screen showing the structure of the solution in Rider](Assets/quick-start/rider-folder-structure.png)

### [**Rider Version 2024.1+**](#tab/rider2024-1)
### [**Previous Rider Version 2024.1**](#tab/rider2024-1)

Creating an Uno Platform project is done [using dotnet new](xref:Uno.GetStarted.dotnet-new) and the Uno Platform Live Wizard by following these steps:

Expand Down Expand Up @@ -48,29 +71,6 @@ Creating an Uno Platform project is done [using dotnet new](xref:Uno.GetStarted.
> [!TIP]
> If you are not able to run the online Live Wizard, you can explore the [`dotnet new` template](xref:Uno.GetStarted.dotnet-new) directly in the CLI.
### [**Rider Version 2024.2+**](#tab/rider2024-2)

Creating an Uno Platform project is done by following these steps:

1. On the **Welcome to JetBrains Rider** screen, click **New Solution**.

![A screen showing the Welcome to JetBrains Rider screen](Assets/quick-start/rider-welcome-screen-new-solution.png)

1. From the project types list on the left, locate and click **Uno Platform App**. It will be under the **Uno Platform** section.
1. Configure your new project by providing a solution name and a directory location.
1. Choose a template to build your application.

![A screen showing the Uno Platform App Template](Assets/quick-start/rider-configure-new-unoplatform-app.png)

> [!TIP]
> For a detailed overview of the Uno Platform project wizard and all its options, see the [Wizard guide](xref:Uno.GettingStarted.UsingWizard).
1. Click the create button and wait for the solution to load.

1. You should now have a folder structure that looks like this:

![A screen showing the structure of the solution in Rider](Assets/quick-start/rider-folder-structure.png)

---

> [!IMPORTANT]
Expand Down
6 changes: 2 additions & 4 deletions doc/articles/get-started-rider.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ uid: Uno.GetStarted.Rider
> [!IMPORTANT]
> Depending on the version of Rider you will want to use, here are some additional information that you will want to know:
>
> - **Previous Rider (2024.1)**: The Uno Plugin for previous versions of Rider (2024.1) does not support creating Uno Platform projects using the "New Solution" dialog, even if the Uno Platform project template appears. In this case, creating an Uno Platform project is done [using dotnet new](xref:Uno.GetStarted.dotnet-new) and the <a target="_blank" href="https://aka.platform.uno/app-wizard">Uno Platform Live Wizard</a>.
>
> - **Current Rider (2024.2 and above)**: For the current Rider version, the Uno Platform plugin supports creating Uno Platform projects using the "New Solution" dialog.
>
> - **Previous Rider (2024.1)**: The Uno Plugin for previous versions of Rider (2024.1) does not support creating Uno Platform projects using the "New Solution" dialog, even if the Uno Platform project template appears. In this case, creating an Uno Platform project is done [using dotnet new](xref:Uno.GetStarted.dotnet-new) and the <a target="_blank" href="https://aka.platform.uno/app-wizard">Uno Platform Live Wizard</a>.
## Prerequisites

Expand Down Expand Up @@ -49,8 +49,6 @@ In Rider, in the **Configure**, **Plugins** menu, open the **Marketplace** tab,

Then click the install button.

---

## Platform specific setup

You may need to follow additional directions, depending on your development environment.
Expand Down

0 comments on commit ff2f3f2

Please sign in to comment.