From b51aa414c51bb4098d980f5ee5c0da3ffe47d466 Mon Sep 17 00:00:00 2001 From: Caelan Sayler Date: Sat, 27 Jan 2024 13:01:31 +0000 Subject: [PATCH] Update readme's to point to new docs --- .github/workflows/docs.yml | 6 +++--- README.md | 6 +++--- README_NUGET.md | 3 ++- docfx/README.md | 1 + 4 files changed, 9 insertions(+), 7 deletions(-) create mode 100644 docfx/README.md diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e59aafdb..bee42f3a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,6 +1,6 @@ # Your GitHub workflow file under .github/workflows/ # Trigger the action on push to main -name: Deploy Docs +name: Docs on: push: @@ -20,11 +20,11 @@ concurrency: cancel-in-progress: false jobs: - publish-docs: + deploy: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} - + runs-on: ubuntu-latest steps: diff --git a/README.md b/README.md index 3d623373..7c599709 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ https://github.com/velopack/velopack/assets/1287295/0ff1bea7-15ed-42ae-8bdd-9519 ## Getting Started -This is a very simple example of the steps you would take to generate an installer and update packages for your application. Be sure to [read the documentation](docs) for an overview of more features! +This is a very simple example of the steps you would take to generate an installer and update packages for your application. Be sure to [read the documentation](https://velopack.io/docs/) for an overview of more features! 1. Install the command line tool `vpk`: ```cmd @@ -69,7 +69,7 @@ This is a very simple example of the steps you would take to generate an install If you're not sure how these instructions fit into your app, check the example apps for common scenarios such as WPF or Avalonia. ## Documentation -- 📖 [Read the docs](docs) +- 📖 [Read the docs](https://velopack.io/docs/) - 🕶️ [View example apps](examples) ## Community @@ -78,7 +78,7 @@ If you're not sure how these instructions fit into your app, check the example a ## Contributing - 💬 Join us on [Discord](https://discord.gg/CjrCrNzd3F) to get involved in dev discussions -- 🚦 Read our [compiling guide](docs/compiling.md) +- 🚦 Read our [compiling guide](https://velopack.io/docs/compiling.html) ## 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! diff --git a/README_NUGET.md b/README_NUGET.md index e46827d0..f13b8914 100644 --- a/README_NUGET.md +++ b/README_NUGET.md @@ -10,4 +10,5 @@ Velopack is an installation and auto-update framework for cross-platform .NET ap ## Getting Started -Please visit our GitHub for up to date documentation on how to use Velopack: https://github.com/velopack/velopack \ No newline at end of file +- Visit our GitHub: https://github.com/velopack/velopack +- Read the documentation: https://velopack.io/docs/ \ No newline at end of file diff --git a/docfx/README.md b/docfx/README.md new file mode 100644 index 00000000..1f277fd9 --- /dev/null +++ b/docfx/README.md @@ -0,0 +1 @@ +If you've reached this page, you're probably [looking for the documentation](https://velopack.io/docs/). \ No newline at end of file