From 38c11e540a059809a866220e49667871dcc409cf Mon Sep 17 00:00:00 2001 From: Elliot Bentine <7041164+ElliotB256@users.noreply.github.com> Date: Wed, 1 Jan 2025 00:30:00 +0000 Subject: [PATCH 1/2] Add some info on upgrading renamed landing to welcome --- content/getting_started/quickstart/index.md | 22 +++++++++++++----- .../{landing => welcome}/AnimatedVehicle.gif | Bin content/{landing => welcome}/_index.md | 5 ++-- 3 files changed, 19 insertions(+), 8 deletions(-) rename content/{landing => welcome}/AnimatedVehicle.gif (100%) rename content/{landing => welcome}/_index.md (64%) diff --git a/content/getting_started/quickstart/index.md b/content/getting_started/quickstart/index.md index b1ae0ba..c32e0f5 100644 --- a/content/getting_started/quickstart/index.md +++ b/content/getting_started/quickstart/index.md @@ -1,17 +1,21 @@ +++ -title = "Setup" -description = "Setup" +title = "Setup or Upgrade" +description = "Setup or Upgrade" weight = 2 date= 2024-10-19 +++ +Welcome to ProPixelizer, let's get started! + +## Setting up a new project + Make sure you have the Universal Render Pipeline package added to the project (if not, you can add this using the Unity Package Manager). -## 1. Import ProPixelizer +### 1. Import ProPixelizer Import ProPixelizer from the Unity Package Manager; it must be located at Assets/ProPixelizer, which is the default location Unity suggests. -## 2. Find your Render Pipeline Asset(s) +### 2. Find your Render Pipeline Asset(s) Universal Render Pipeline stores your project's graphical configuration in a Render Pipeline Asset. These assets are commonly stored in Assets/Settings. @@ -22,7 +26,7 @@ Please note that your project very likely has multiple Render Pipeline Assets, a ![demonstration of project quality settings](project_quality_settings.png "Quality Settings") -## 3. Configure your Render Pipeline Asset(s) +### 3. Configure your Render Pipeline Asset(s) You can now add ProPixelizer to each Render Pipeline Asset that you are using. @@ -34,7 +38,13 @@ You can now add ProPixelizer to each Render Pipeline Asset that you are using. ![example renderer](renderer.png) -## 4. Check out the examples! +## Upgrading from an older version + +If your project is already using a previous version of ProPixelizer which was imported into your Project's `Assets` folder, **please delete this old version first** and then import the new version using the Unity Package Manager. The new version will be installed to `Packages/ProPixelizer`. + +ProPixelizer uses the same `.meta` files for all assets and source files between versions and so your project will automatically use the updated scripts, Monobehaviors and assets from the new package version. For more detailed update notes and version history, see the [changelog](@/versions/changelog/index.md) and [update guide](@/versions/updating_from_prev/index.md). + +## Check out the examples! You have now configured your project for ProPixelizer. The [example scenes](../examples) show you lots of interesting things you can do with ProPixelizer, and showcase various features of the plugin, so I recommend taking a look! diff --git a/content/landing/AnimatedVehicle.gif b/content/welcome/AnimatedVehicle.gif similarity index 100% rename from content/landing/AnimatedVehicle.gif rename to content/welcome/AnimatedVehicle.gif diff --git a/content/landing/_index.md b/content/welcome/_index.md similarity index 64% rename from content/landing/_index.md rename to content/welcome/_index.md index b999115..10078b1 100644 --- a/content/landing/_index.md +++ b/content/welcome/_index.md @@ -7,10 +7,11 @@ render = true ![propixelizer vehicle](AnimatedVehicle.gif) -Welcome to ProPixelizer! +Welcome to ProPixelizer's documentation! -- Use the navigation at the side to see what topics are available. - For setting up a new project, see the [Quick Start](@/getting_started/quickstart/index.md) guide. +- Check out the [examples](@/getting_started/examples/index.md) for hands-on demos. +- For a more detailed description of how to use the package, start with the [overview](@/usage/overview/index.md). I hope you enjoy using ProPixelizer. Please do message me if you have any questions or problems. I'm always very pleased to hear what you make with it! From 1943cce04142c2b103346084eeb3810b7bfcfcbe Mon Sep 17 00:00:00 2001 From: Elliot Bentine <7041164+ElliotB256@users.noreply.github.com> Date: Wed, 1 Jan 2025 00:48:45 +0000 Subject: [PATCH 2/2] Theme now handles 404s --- themes/zola_easydocs_theme | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/zola_easydocs_theme b/themes/zola_easydocs_theme index 69f23e4..33b3d22 160000 --- a/themes/zola_easydocs_theme +++ b/themes/zola_easydocs_theme @@ -1 +1 @@ -Subproject commit 69f23e4f61c053b652a7c3466a6426f4d4cf242c +Subproject commit 33b3d22743a4828dd8c31c16b4060a9a1a38c4f5