mirror of
https://github.com/velopack/velopack.git
synced 2025-10-25 15:19:22 +00:00
docs: sort out landing pages
This commit is contained in:
@@ -11,7 +11,7 @@
|
|||||||
[](https://app.codecov.io/gh/velopack/velopack)
|
[](https://app.codecov.io/gh/velopack/velopack)
|
||||||
[](https://github.com/velopack/velopack/blob/develop/LICENSE)
|
[](https://github.com/velopack/velopack/blob/develop/LICENSE)
|
||||||
|
|
||||||
Velopack is a setup / installation framework for cross-platform dotnet applications. Great out-of-the-box development experience, with zero configuration or setup needed. Lightning fast to use, and lightning fast for your users, too.
|
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.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# Velopack
|
# Velopack
|
||||||
Velopack is a setup / installation framework for cross-platform dotnet applications. Great out-of-the-box development experience, with zero configuration or setup needed. Lightning fast to use, and lightning fast for your users, too.
|
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.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
|||||||
1
docfx/.gitignore
vendored
1
docfx/.gitignore
vendored
@@ -1,2 +1,3 @@
|
|||||||
api/
|
api/
|
||||||
|
sdk/
|
||||||
_site/
|
_site/
|
||||||
@@ -9,7 +9,7 @@
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"dest": "api"
|
"dest": "sdk"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"build": {
|
"build": {
|
||||||
|
|||||||
28
docfx/docs/index.md
Normal file
28
docfx/docs/index.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Velopack Documentation
|
||||||
|
🚧🚧This documentation is still under construction.🚧🚧
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Be sure to check us out on [GitHub](https://github.com/velopack/velopack) and [join our Discord](https://discord.gg/CjrCrNzd3F) for any questions/support!
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
To enable your application to make full use of Velopack, you need to do 3 things:
|
||||||
|
1. Add the SDK to your app, and check for updates. [[Read more]](updating/overview.md)
|
||||||
|
0. Run the `vpk` command line tool to generate your update packages and installers. [[Read more]](packaging/overview.md)
|
||||||
|
0. Upload your release somewhere your app can download updates from. [[Read more]](distributing/overview.md)
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> If you are migrating an application from Squirrel.Windows or Clowd.Squirrel, you may also want to read [the migrating guide](migrating.md).
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
- [C# .NET Quick Start](getting-started/csharp.md)
|
||||||
|
- Sample App: [Avalonia Cross Platform](https://github.com/velopack/velopack/tree/master/examples/AvaloniaCrossPlat)
|
||||||
|
- Sample App: [WPF / .Net Framework](https://github.com/velopack/velopack/tree/master/examples/VeloWpfSample)
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
- **My application was detected as a virus?** <br/>
|
||||||
|
Velopack can't help with this, but you can [code-sign](packaging/signing.md) your app and check [other suggestions here](https://github.com/clowd/lowd.Squirrel/issues/28#issuecomment-1016241760).
|
||||||
|
- **What happened to SquirrelAwareApp? / Shortcuts** <br/>
|
||||||
|
This concept no longer exists in Velopack. You can create hooks on install/update in a similar way using the `VelopackApp` builder. Although note that reating shortcuts or registry entries yourself during hooks is no longer required.
|
||||||
|
- **Can Velopack bootstrap new runtimes during updates?** <br/>
|
||||||
|
Yes, this is fully supported. Before installing updates, Velopack will prompt the user to install any missing updates.
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
- name: Welcome
|
- name: Welcome
|
||||||
href: welcome.md
|
href: index.md
|
||||||
|
|
||||||
- name: Getting Started
|
- name: Getting Started
|
||||||
href: getting-started/toc.yml
|
href: getting-started/toc.yml
|
||||||
@@ -12,6 +12,10 @@
|
|||||||
- name: C# WPF / .Net Framework
|
- name: C# WPF / .Net Framework
|
||||||
href: https://github.com/velopack/velopack/tree/master/examples/VeloWpfSample
|
href: https://github.com/velopack/velopack/tree/master/examples/VeloWpfSample
|
||||||
|
|
||||||
|
- name: App Updating
|
||||||
|
href: updating/toc.yml
|
||||||
|
homepage: updating/overview.md
|
||||||
|
|
||||||
- name: Packaging Releases
|
- name: Packaging Releases
|
||||||
href: packaging/toc.yml
|
href: packaging/toc.yml
|
||||||
homepage: packaging/overview.md
|
homepage: packaging/overview.md
|
||||||
@@ -20,10 +24,6 @@
|
|||||||
href: distributing/toc.yml
|
href: distributing/toc.yml
|
||||||
homepage: distributing/overview.md
|
homepage: distributing/overview.md
|
||||||
|
|
||||||
- name: Updating
|
|
||||||
href: updating/toc.yml
|
|
||||||
homepage: updating/overview.md
|
|
||||||
|
|
||||||
- name: Troubleshooting
|
- name: Troubleshooting
|
||||||
href: troubleshooting/toc.yml
|
href: troubleshooting/toc.yml
|
||||||
homepage: troubleshooting/debugging.md
|
homepage: troubleshooting/debugging.md
|
||||||
|
|||||||
@@ -1,11 +0,0 @@
|
|||||||
# Velopack Documentation
|
|
||||||
🚧🚧This documentation is still under construction.🚧🚧
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
- **My application was detected as a virus?** <br/>
|
|
||||||
Velopack can't help with this, but you can [code-sign](packaging/signing.md) your app and check [other suggestions here](https://github.com/clowd/Clowd.Squirrel/issues/28#issuecomment-1016241760).
|
|
||||||
- **What happened to SquirrelAwareApp? / Shortcuts** <br/>
|
|
||||||
This concept no longer exists in Velopack. You can create hooks on install/update in a similar way using the `VelopackApp` builder. Although note that creating shortcuts or registry entries yourself during hooks is no longer required.
|
|
||||||
- **Can Velopack bootstrap new runtimes during updates?** <br/>
|
|
||||||
Yes, this is fully supported. Before installing updates, Velopack will prompt the user to install any missing updates.
|
|
||||||
|
|
||||||
7
docfx/index.html
Normal file
7
docfx/index.html
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
<span>
|
||||||
|
Welcome, there's nothing here, you're probably looking for <a href="/docs">the documentation</a>.
|
||||||
|
</span>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
window.location.href = '/docs';
|
||||||
|
</script>
|
||||||
@@ -2,6 +2,4 @@
|
|||||||
_layout: landing
|
_layout: landing
|
||||||
---
|
---
|
||||||
|
|
||||||
# WIP
|
[!INCLUDE [index](index.html)]
|
||||||
|
|
||||||
You probably just want to visit [the documentation](docs/welcome.md).
|
|
||||||
@@ -4,6 +4,11 @@ export default {
|
|||||||
icon: 'github',
|
icon: 'github',
|
||||||
href: 'https://github.com/velopack/velopack',
|
href: 'https://github.com/velopack/velopack',
|
||||||
title: 'GitHub'
|
title: 'GitHub'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
icon: 'discord',
|
||||||
|
href: 'https://discord.gg/CjrCrNzd3F',
|
||||||
|
title: 'Discord'
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
- name: Docs
|
- name: Docs
|
||||||
href: docs/
|
href: docs/
|
||||||
- name: API
|
- name: C# SDK
|
||||||
href: api/
|
href: sdk/
|
||||||
Reference in New Issue
Block a user