From 07a3973f9ac9bec258ca4575e0c93375c0975d4e Mon Sep 17 00:00:00 2001 From: Misite Bao Date: Mon, 19 Sep 2022 20:02:11 +0800 Subject: [PATCH] feat(website): optimize and improve documentation --- .../2021-09-27-v2-beta1-release-notes.mdx | 2 +- website/docs/gettingstarted/development.mdx | 2 +- website/docs/gettingstarted/installation.mdx | 2 +- website/docs/introduction.mdx | 5 ++++- website/docs/reference/options.mdx | 6 +++--- website/src/pages/credits.mdx | 20 ++++++++---------- .../bronze-sponsor.webp} | Bin website/static/img/{ => sponsor}/easyweb.webp | Bin .../{ => sponsor}/jetbrains-grayscale.webp | Bin .../silver-sponsor.webp} | Bin 10 files changed, 19 insertions(+), 18 deletions(-) rename website/static/img/{bronze sponsor.webp => sponsor/bronze-sponsor.webp} (100%) rename website/static/img/{ => sponsor}/easyweb.webp (100%) rename website/static/img/{ => sponsor}/jetbrains-grayscale.webp (100%) rename website/static/img/{silver sponsor.webp => sponsor/silver-sponsor.webp} (100%) diff --git a/website/blog/2021-09-27-v2-beta1-release-notes.mdx b/website/blog/2021-09-27-v2-beta1-release-notes.mdx index 413a3be01..989ac2c2c 100644 --- a/website/blog/2021-09-27-v2-beta1-release-notes.mdx +++ b/website/blog/2021-09-27-v2-beta1-release-notes.mdx @@ -197,7 +197,7 @@ months ago. I also need to give a huge thank you :pray: to the following people because without them, this release just wouldn't exist: -- [Misitebao](https://github.com/misitebao) - An absolute workhorse on the Chinese translations and an incredible bug finder. +- [Misite Bao](https://github.com/misitebao) - An absolute workhorse on the Chinese translations and an incredible bug finder. - [John Chadwick](https://github.com/jchv) - His amazing work on [go-webview2](https://github.com/jchv/go-webview2) and [go-winloader](https://github.com/jchv/go-winloader) have made the Windows version we have today possible. - [Tad Vizbaras](https://github.com/tadvi) - Experimenting with his [winc](https://github.com/tadvi/winc) project was the first step down the path to a pure Go Wails. diff --git a/website/docs/gettingstarted/development.mdx b/website/docs/gettingstarted/development.mdx index 54dda5faa..a0075ef69 100644 --- a/website/docs/gettingstarted/development.mdx +++ b/website/docs/gettingstarted/development.mdx @@ -8,7 +8,7 @@ You can run your application in development mode by running `wails dev` from you - Build your application and run it - Bind your Go code to the frontend so it can be called from Javascript -- Using the power of [vite](https://vitejs.dev/), will watch for modifications in your Go files and rebuild/re-run on change +- Using the power of [Vite](https://vitejs.dev/), will watch for modifications in your Go files and rebuild/re-run on change - Sets up a [webserver](http://localhost:34115) that will serve your application over a browser. This allows you to use your favourite browser extensions. You can even call your Go code from the console To get started, run `wails dev` in the project directory. More information on this can be found [here](../reference/cli.mdx#dev). diff --git a/website/docs/gettingstarted/installation.mdx b/website/docs/gettingstarted/installation.mdx index 70ef0ded5..2bd3c8f9c 100644 --- a/website/docs/gettingstarted/installation.mdx +++ b/website/docs/gettingstarted/installation.mdx @@ -20,7 +20,7 @@ Wails has a number of common dependencies that are required before installation: ### Go -Download Go from the [Go Downloads Page](https://go.dev/doc/install). +Download Go from the [Go Downloads Page](https://go.dev/dl/). Ensure that you follow the official [Go installation instructions](https://go.dev/doc/install). You will also need to ensure that your `PATH` environment variable also includes the path to your `~/go/bin` directory. Restart your terminal and do the following checks: diff --git a/website/docs/introduction.mdx b/website/docs/introduction.mdx index d890aba9a..0c4e87cb6 100644 --- a/website/docs/introduction.mdx +++ b/website/docs/introduction.mdx @@ -29,7 +29,10 @@ you'd expect from a modern native app. ```mdx-code-block

- +

``` diff --git a/website/docs/reference/options.mdx b/website/docs/reference/options.mdx index 039f6a92c..0470aaf8d 100644 --- a/website/docs/reference/options.mdx +++ b/website/docs/reference/options.mdx @@ -364,7 +364,7 @@ Type: `[]interface{}` ### Windows -This defines [Windows specific options](#windows-specific-options). +This defines [Windows specific options](#windows). Name: Windows
Type: `*windows.Options` @@ -529,7 +529,7 @@ Type: `func()` ### Mac -This defines [Mac specific options](#mac-specific-options). +This defines [Mac specific options](#mac). Name: Mac
Type: `*mac.Options` @@ -695,7 +695,7 @@ When clicked, that will open an about message box: ### Linux -This defines [Linux specific options](#linux-specific-options). +This defines [Linux specific options](#linux). Name: Linux
Type: `*linux.Options` diff --git a/website/src/pages/credits.mdx b/website/src/pages/credits.mdx index e09725906..2a7b20fd2 100644 --- a/website/src/pages/credits.mdx +++ b/website/src/pages/credits.mdx @@ -2,7 +2,7 @@ - [Lea Anthony](https://github.com/leaanthony) - Project owner, lead developer - [Stffabi](https://github.com/stffabi) - Technical lead, developer and maintainer -- [Misitebao](https://github.com/misitebao) - Documentation wizard, Chinese translation, Windows testing, Bug finder general +- [Misite Bao](https://github.com/misitebao) - Documentation wizard, Chinese translation, Windows testing, Bug finder general - [Travis McLane](https://github.com/tmclane) - Cross-compilation work, MacOS testing - [Byron Chris](https://github.com/bh90210) - Linux distro wizard, Linux testing @@ -12,30 +12,29 @@ dangerouslySetInnerHTML={{ __html: ` - + - +
-
- - - + + + - +
-
+ - + @@ -85,7 +84,6 @@ -directory diff --git a/website/static/img/bronze sponsor.webp b/website/static/img/sponsor/bronze-sponsor.webp similarity index 100% rename from website/static/img/bronze sponsor.webp rename to website/static/img/sponsor/bronze-sponsor.webp diff --git a/website/static/img/easyweb.webp b/website/static/img/sponsor/easyweb.webp similarity index 100% rename from website/static/img/easyweb.webp rename to website/static/img/sponsor/easyweb.webp diff --git a/website/static/img/jetbrains-grayscale.webp b/website/static/img/sponsor/jetbrains-grayscale.webp similarity index 100% rename from website/static/img/jetbrains-grayscale.webp rename to website/static/img/sponsor/jetbrains-grayscale.webp diff --git a/website/static/img/silver sponsor.webp b/website/static/img/sponsor/silver-sponsor.webp similarity index 100% rename from website/static/img/silver sponsor.webp rename to website/static/img/sponsor/silver-sponsor.webp