sort out links to new doc site

2025-10-25 15:19:22 +00:00 · 2024-03-03 17:41:25 +00:00
parent e68f3507ab
commit f89b4028e8
10 changed files with 102 additions and 46 deletions
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -1,21 +0,0 @@
-name: Docs
-
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  dispatch:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/github-script@v6
-        with:
-          github-token: ${{ secrets.DOCS_TOKEN }}
-          script: |
-            await github.rest.actions.createWorkflowDispatch({
-              owner: 'velopack',
-              repo: 'velopack.website',
-              workflow_id: 'build.yml',
-              ref: 'master'
-            })
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="docfx/images/velopack-white.svg">
-  <img alt="Velopack Logo" src="docfx/images/velopack-black.svg" width="400">
+  <source media="(prefers-color-scheme: dark)" srcset="artwork/velopack-white.svg">
+  <img alt="Velopack Logo" src="artwork/velopack-black.svg" width="400">
 </picture>

 ---
@@ -15,18 +15,18 @@ Velopack is an installation and auto-update framework for cross-platform applica

 ## Features

- 😍 **Zero config** – Velopack takes your dotnet build output (eg. `dotnet publish`), and generates an installer, and updates and delta packages in a single command.
- 🎯 **Cross platform** – Velopack supports building packages for **Windows**, **OSX**, and **Linux**. No matter your target, Velopack can create a release in just one command.
- 🚀 **Automatic migrations** - If you are coming from [Squirrel.Windows](https://github.com/Squirrel/Squirrel.Windows) or [Clowd.Squirrel](https://github.com/clowd/Clowd.Squirrel), Velopack will automatically migrate your application. Just build your Velopack release and deploy! [Read more.](https://velopack.io/docs/migrating.html)
- ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Creating releases is multi-threaded, and produces delta packages for ultra fast app updates. Applying update packages is highly optimised, and often can be done in the background.
- 📔 **Language agnostic** - With support for C#, Rust, JS, and more. Use a familiar API for updates no matter what your project is written in. Check out [Velopack Fusion](https://github.com/velopack/velopack.fusion) for more info.
+- 😍 **Zero config** – Velopack takes your compiler output and generates an installer, updates, delta packages, and self-updating portable package in just one command.
+- 🎯 **Cross platform** – Velopack supports building packages for **Windows**, **OSX**, and **Linux**, so you can use one solution for every target.
+- 🚀 **Automatic migrations** - If you are coming from other popular frameworks (eg. [Squirrel](https://github.com/Squirrel/Squirrel.Windows)), Velopack can automatically migrate your application.
+- ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Delta packages mean your user only downloads what's changed between versions.
+- 📔 **Language agnostic** - With support for C#, C++, JS, Rust and more. Use a familiar API for updates no matter what language your project is.

 https://github.com/velopack/velopack/assets/1287295/0ff1bea7-15ed-42ae-8bdd-9519f1033432

 ## Documentation
- ⚡ [Quick start guides](https://velopack.io/docs/getting-started/csharp.html)
- 🕶️ [View example apps](samples)
- 📖 [Read the docs](https://velopack.io/docs/)
+- 📖 [Read the docs](https://docs.velopack.io/)
+- ⚡ [Quick start guides](https://docs.velopack.io/category/quick-start)
+- 🕶️ [View example apps](https://docs.velopack.io/category/sample-apps)

 ## Community
 - ❓ Ask questions, get support, or discuss ideas on [our Discord server](https://discord.gg/CjrCrNzd3F)
@@ -34,7 +34,7 @@ https://github.com/velopack/velopack/assets/1287295/0ff1bea7-15ed-42ae-8bdd-9519

 ## Contributing
 - 💬 Join us on [Discord](https://discord.gg/CjrCrNzd3F) to get involved in dev discussions
- 🚦 Read our [compiling guide](https://velopack.io/docs/compiling.html)
+- 🚦 Read our [contributing guide](https://docs.velopack.io/category/contributing)

 ## Testimonials 
 I have now got my external facing application using velopack. I am very impressed. Seems to work fabulously well and be much faster both in the initial build and in the upgrading of the software on the end user's  machine than Squirrel was. It's amazing and the best installer I've ever used in over 30 years of development. Thanks so much!  You are doing some great work!
--- a/README_NUGET.md
+++ b/README_NUGET.md
@@ -1,14 +1,19 @@
 # Velopack
-Velopack is an installation and auto-update framework for cross-platform .NET applications. It's opinionated, extremely easy to use with zero config needed. With just one command you can be up and running with an installable application, and it's lightning fast for your users, too.
+Velopack is an installation and auto-update framework for cross-platform applications. It's opinionated, extremely easy to use with zero config needed. With just one command you can be up and running with an installable application, and it's lightning fast for your users, too.

 ## Features

- 😍 **Zero config** – Velopack takes your dotnet build output (eg. `dotnet publish`), and generates an installer, and update package in a single command.
- 🎯 **Cross platform** – Velopack supports building packages for Windows and OSX, and Linux. No matter your target, Velopack can create a release in just one command.
- 🚀 **Automatic migrations** - If you are coming from [Squirrel.Windows](https://github.com/Squirrel/Squirrel.Windows) or [Clowd.Squirrel](https://github.com/clowd/Clowd.Squirrel), Velopack will automatically migrate your application. Just build your Velopack release and deploy! [Read more.](https://velopack.io/docs/migrating.html)
- ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Creating releases is multi-threaded, and produces delta packages for ultra fast app updates. Applying update packages is highly optimised, and often can be done in the background.
+- 😍 **Zero config** – Velopack takes your compiler output and generates an installer, updates, delta packages, and self-updating portable package in just one command.
+- 🎯 **Cross platform** – Velopack supports building packages for **Windows**, **OSX**, and **Linux**, so you can use one solution for every target.
+- 🚀 **Automatic migrations** - If you are coming from other popular frameworks (eg. [Squirrel](https://github.com/Squirrel/Squirrel.Windows)), Velopack can automatically migrate your application.
+- ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Delta packages mean your user only downloads what's changed between versions.
+- 📔 **Language agnostic** - With support for C#, C++, JS, Rust and more. Use a familiar API for updates no matter what language your project is.

-## Getting Started
+## Documentation
+- 📖 [Read the docs](https://docs.velopack.io/)
+- ⚡ [Quick start guides](https://docs.velopack.io/category/quick-start)
+- 🕶️ [View example apps](https://docs.velopack.io/category/sample-apps)

- Visit our GitHub: https://github.com/velopack/velopack
- Read the documentation: https://velopack.io/docs/
+## Community
+- ❓ Ask questions, get support, or discuss ideas on [our Discord server](https://discord.gg/CjrCrNzd3F)
+- 🗣️ Report bugs on [GitHub Issues](https://github.com/velopack/velopack/issues)
--- a/artwork/Velopack_200.png
+++ b/artwork/Velopack_200.png
--- a/artwork/velopack-black.svg
+++ b/artwork/velopack-black.svg
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Layer_2" data-name="Layer 2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 827.38 151.06">
+  <defs>
+    <style>
+      .cls-1 {
+        fill: url(#linear-gradient);
+      }
+
+      .cls-1, .cls-2 {
+        stroke-width: 0px;
+      }
+
+      .cls-2 {
+        fill: #182226;
+      }
+    </style>
+    <linearGradient id="linear-gradient" x1="16.38" y1="88.39" x2="121.56" y2="1.68" gradientUnits="userSpaceOnUse">
+      <stop offset="0" stop-color="#e2bd23"/>
+      <stop offset=".99" stop-color="#edd323"/>
+    </linearGradient>
+  </defs>
+  <g id="Layer_1-2" data-name="Layer 1">
+    <g>
+      <path class="cls-1" d="M168.58,1.97l-85.2,132.33c-.5.78-1.65.78-2.15,0l-28.65-44.51c-.55-.85.06-1.97,1.08-1.97h49.55c1.4,0,1.78-1.93.48-2.46l-67.27-27.55c-1.3-.53-.92-2.46.48-2.46h87.16c1.4,0,1.78-1.93.48-2.46L.8,2.46C-.5,1.93-.12,0,1.28,0h166.22c1.01,0,1.62,1.12,1.07,1.97Z"/>
+      <g>
+        <path class="cls-2" d="M312.65,25.16l-38.44,98.16c-.18.47-.65.79-1.16.79h-14.89c-.51,0-.98-.33-1.16-.79l-35.19-90.25-12.79-5.42c-2.28-.85-1.64-4.19.76-4.19h24.69c.51,0,.98.31,1.16.79l30.04,79.59,30.04-79.59c.18-.49.65-.79,1.16-.79h14.6c.89,0,1.5.89,1.17,1.7Z"/>
+        <path class="cls-2" d="M344.44,48.98c-18.71,0-37,13.47-37,38.28s18.15,38.28,38.14,38.28c12.01,0,22.32-4.73,28.76-12.17.42-.49.39-1.23-.06-1.69l-5.75-5.97c-.47-.48-1.22-.5-1.72-.06-5.27,4.57-12.02,6.85-19.53,6.85-12.62,0-22.68-6.52-25.09-19.28h57.84c3.54-30.91-16.87-44.23-35.59-44.23ZM322.04,81.59c2.27-13.04,12.19-19.28,22.54-19.28s20.7,6.52,21.55,19.28h-44.09Z"/>
+        <path class="cls-2" d="M391.59,124.12h15.6V24.71c0-.69-.56-1.25-1.25-1.25h-13.09c-.69,0-1.25.56-1.25,1.25v99.41Z"/>
+        <path class="cls-2" d="M456.88,48.98c-19.14,0-38.56,13.47-38.56,38.28s19.42,38.28,38.56,38.28,38.56-13.47,38.56-38.28-19.42-38.28-38.56-38.28ZM456.88,111.22c-12.05,0-23.11-8.79-23.11-23.96s11.06-23.96,23.11-23.96,22.97,8.79,22.97,23.96-10.92,23.96-22.97,23.96Z"/>
+        <path class="cls-2" d="M546.7,48.98c-13.47,0-22.83,7.37-25.52,13.18h-.42v-10.51c0-.69-.56-1.25-1.25-1.25h-13.09c-.69,0-1.25.56-1.25,1.25v98.16c0,.69.56,1.25,1.25,1.25h13.09c.69,0,1.25-.56,1.25-1.25v-37.45h.42c2.69,5.81,12.05,13.19,25.52,13.19,17.44,0,35.73-12.9,35.73-38.28s-18.29-38.28-35.73-38.28ZM543.72,111.36c-11.91,0-23.39-8.22-23.39-24.1s11.48-24.1,23.39-24.1,23.25,8.22,23.25,24.1-11.48,24.1-23.25,24.1Z"/>
+        <path class="cls-2" d="M651.69,62.16h-.42c-2.69-5.81-12.05-13.18-25.52-13.18-17.44,0-35.73,12.9-35.73,38.28s18.29,38.28,35.73,38.28c13.47,0,22.83-7.37,25.52-13.19h.42v10.52c0,.69.56,1.25,1.25,1.25h13.09c.69,0,1.25-.56,1.25-1.25V51.65c0-.69-.56-1.25-1.25-1.25h-13.09c-.69,0-1.25.56-1.25,1.25v10.51ZM628.72,111.36c-11.77,0-23.25-8.22-23.25-24.1s11.48-24.1,23.25-24.1,23.39,8.22,23.39,24.1-11.48,24.1-23.39,24.1Z"/>
+        <path class="cls-2" d="M717.12,63.3c7.94,0,14.86,3.84,19.18,10.05.38.55,1.12.73,1.69.37l9.55-5.94c.58-.36.78-1.14.42-1.72-6.89-11.34-18.48-17.08-30.99-17.08-19.28,0-38.56,13.47-38.56,38.28s19.28,38.28,38.56,38.28c12.51,0,24.08-5.86,30.98-17.07.36-.59.17-1.37-.42-1.73l-9.55-5.94c-.57-.36-1.31-.18-1.69.37-4.32,6.21-11.24,10.05-19.18,10.05-11.91,0-23.25-8.79-23.25-23.96s11.34-23.96,23.25-23.96Z"/>
+        <path class="cls-2" d="M795.31,83.43l28.28-30.94c.73-.8.16-2.1-.92-2.1h-15.6c-.36,0-.69.15-.93.42l-30.96,34.46V24.71c0-.69-.56-1.25-1.25-1.25h-13.09c-.69,0-1.25.56-1.25,1.25v98.16c0,.69.56,1.25,1.25,1.25h13.09c.69,0,1.25-.56,1.25-1.25v-17.46l10.35-11.2,25,29.47c.24.28.59.44.95.44h14.63c1.06,0,1.64-1.23.97-2.05l-31.78-38.64Z"/>
+      </g>
+    </g>
+  </g>
+</svg>
--- a/artwork/velopack-white.svg
+++ b/artwork/velopack-white.svg
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Layer_2" data-name="Layer 2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 827.38 151.06">
+  <defs>
+    <style>
+      .cls-1 {
+        fill: url(#linear-gradient);
+      }
+
+      .cls-1, .cls-2 {
+        stroke-width: 0px;
+      }
+
+      .cls-2 {
+        fill: #fff;
+      }
+    </style>
+    <linearGradient id="linear-gradient" x1="16.38" y1="88.39" x2="121.56" y2="1.68" gradientUnits="userSpaceOnUse">
+      <stop offset="0" stop-color="#e2bd23"/>
+      <stop offset=".99" stop-color="#edd323"/>
+    </linearGradient>
+  </defs>
+  <g id="Layer_1-2" data-name="Layer 1">
+    <g>
+      <path class="cls-1" d="M168.58,1.97l-85.2,132.33c-.5.78-1.65.78-2.15,0l-28.65-44.51c-.55-.85.06-1.97,1.08-1.97h49.55c1.4,0,1.78-1.93.48-2.46l-67.27-27.55c-1.3-.53-.92-2.46.48-2.46h87.16c1.4,0,1.78-1.93.48-2.46L.8,2.46C-.5,1.93-.12,0,1.28,0h166.22c1.01,0,1.62,1.12,1.07,1.97Z"/>
+      <g>
+        <path class="cls-2" d="M312.65,25.16l-38.44,98.16c-.18.47-.65.79-1.16.79h-14.89c-.51,0-.98-.33-1.16-.79l-35.19-90.25-12.79-5.42c-2.28-.85-1.64-4.19.76-4.19h24.69c.51,0,.98.31,1.16.79l30.04,79.59,30.04-79.59c.18-.49.65-.79,1.16-.79h14.6c.89,0,1.5.89,1.17,1.7Z"/>
+        <path class="cls-2" d="M344.44,48.98c-18.71,0-37,13.47-37,38.28s18.15,38.28,38.14,38.28c12.01,0,22.32-4.73,28.76-12.17.42-.49.39-1.23-.06-1.69l-5.75-5.97c-.47-.48-1.22-.5-1.72-.06-5.27,4.57-12.02,6.85-19.53,6.85-12.62,0-22.68-6.52-25.09-19.28h57.84c3.54-30.91-16.87-44.23-35.59-44.23ZM322.04,81.59c2.27-13.04,12.19-19.28,22.54-19.28s20.7,6.52,21.55,19.28h-44.09Z"/>
+        <path class="cls-2" d="M391.59,124.12h15.6V24.71c0-.69-.56-1.25-1.25-1.25h-13.09c-.69,0-1.25.56-1.25,1.25v99.41Z"/>
+        <path class="cls-2" d="M456.88,48.98c-19.14,0-38.56,13.47-38.56,38.28s19.42,38.28,38.56,38.28,38.56-13.47,38.56-38.28-19.42-38.28-38.56-38.28ZM456.88,111.22c-12.05,0-23.11-8.79-23.11-23.96s11.06-23.96,23.11-23.96,22.97,8.79,22.97,23.96-10.92,23.96-22.97,23.96Z"/>
+        <path class="cls-2" d="M546.7,48.98c-13.47,0-22.83,7.37-25.52,13.18h-.42v-10.51c0-.69-.56-1.25-1.25-1.25h-13.09c-.69,0-1.25.56-1.25,1.25v98.16c0,.69.56,1.25,1.25,1.25h13.09c.69,0,1.25-.56,1.25-1.25v-37.45h.42c2.69,5.81,12.05,13.19,25.52,13.19,17.44,0,35.73-12.9,35.73-38.28s-18.29-38.28-35.73-38.28ZM543.72,111.36c-11.91,0-23.39-8.22-23.39-24.1s11.48-24.1,23.39-24.1,23.25,8.22,23.25,24.1-11.48,24.1-23.25,24.1Z"/>
+        <path class="cls-2" d="M651.69,62.16h-.42c-2.69-5.81-12.05-13.18-25.52-13.18-17.44,0-35.73,12.9-35.73,38.28s18.29,38.28,35.73,38.28c13.47,0,22.83-7.37,25.52-13.19h.42v10.52c0,.69.56,1.25,1.25,1.25h13.09c.69,0,1.25-.56,1.25-1.25V51.65c0-.69-.56-1.25-1.25-1.25h-13.09c-.69,0-1.25.56-1.25,1.25v10.51ZM628.72,111.36c-11.77,0-23.25-8.22-23.25-24.1s11.48-24.1,23.25-24.1,23.39,8.22,23.39,24.1-11.48,24.1-23.39,24.1Z"/>
+        <path class="cls-2" d="M717.12,63.3c7.94,0,14.86,3.84,19.18,10.05.38.55,1.12.73,1.69.37l9.55-5.94c.58-.36.78-1.14.42-1.72-6.89-11.34-18.48-17.08-30.99-17.08-19.28,0-38.56,13.47-38.56,38.28s19.28,38.28,38.56,38.28c12.51,0,24.08-5.86,30.98-17.07.36-.59.17-1.37-.42-1.73l-9.55-5.94c-.57-.36-1.31-.18-1.69.37-4.32,6.21-11.24,10.05-19.18,10.05-11.91,0-23.25-8.79-23.25-23.96s11.34-23.96,23.25-23.96Z"/>
+        <path class="cls-2" d="M795.31,83.43l28.28-30.94c.73-.8.16-2.1-.92-2.1h-15.6c-.36,0-.69.15-.93.42l-30.96,34.46V24.71c0-.69-.56-1.25-1.25-1.25h-13.09c-.69,0-1.25.56-1.25,1.25v98.16c0,.69.56,1.25,1.25,1.25h13.09c.69,0,1.25-.56,1.25-1.25v-17.46l10.35-11.2,25,29.47c.24.28.59.44.95.44h14.63c1.06,0,1.64-1.23.97-2.05l-31.78-38.64Z"/>
+      </g>
+    </g>
+  </g>
+</svg>
--- a/samples/AvaloniaCrossPlat/readme.md
+++ b/samples/AvaloniaCrossPlat/readme.md
@@ -43,5 +43,3 @@ class Program
 This project has a folder of development build scripts (e.g. `.\dev-scripts\build-win.bat`) which will create a release in same way as the main scripts, except with a project reference to Velopack, and it will invoke the local vpk tool as well. 

 If you have made a change to Velopack and would like to test it in the sample app, these are the scripts you should run instead.
-
-Don't forget to review the [compiling guide](../../docs/compiling.md) to make sure you can build Velopack.
--- a/samples/readme.md
+++ b/samples/readme.md
@@ -7,4 +7,4 @@
 ## Other Languages
 Note that only sample apps written in C# using the core reference library are available here. 

-For other programming languages (Rust, C++, JS, etc) please visit the [Velopack Fusion](https://github.com/velopack/velopack.fusion) repository.
+For other programming languages (Rust, C++, JS, etc) please visit the [Velopack Documentation](https://docs.velopack.io/category/sample-apps).
--- a/src/Velopack.Vpk/Velopack.Vpk.csproj
+++ b/src/Velopack.Vpk/Velopack.Vpk.csproj
@@ -19,7 +19,7 @@
  </PropertyGroup>

  <ItemGroup>
-    <None Include="..\..\docfx\images\Velopack_200.png" Pack="true" PackagePath="\" />
+    <None Include="..\..\artwork\Velopack_200.png" Pack="true" PackagePath="\" />
    <None Include="..\..\README_NUGET.md" Pack="true" PackagePath="\" />
  </ItemGroup>

--- a/src/Velopack/Velopack.csproj
+++ b/src/Velopack/Velopack.csproj
@@ -22,7 +22,7 @@
  </PropertyGroup>

  <ItemGroup>
-    <None Include="..\..\docfx\images\Velopack_200.png" Pack="true" PackagePath="\" />
+    <None Include="..\..\artwork\Velopack_200.png" Pack="true" PackagePath="\" />
    <None Include="..\..\README_NUGET.md" Pack="true" PackagePath="\" />
  </ItemGroup>