diff --git a/mkdocs-website/docs/development/introduction.md b/mkdocs-website/docs/development/introduction.md index 10b6d8d1e..72cd12943 100644 --- a/mkdocs-website/docs/development/introduction.md +++ b/mkdocs-website/docs/development/introduction.md @@ -134,14 +134,17 @@ The `InjectJS()` method returns JavaScript that should be injected into all windows as they are created. This is useful for adding custom JavaScript functions that complement the plugin. -## Misc Tasks +The built-in plugins can be found in the `v3/plugins` directory. +Check them out for inspiration. -### Upgrading Taskfile +## Tasks The Wails CLI uses the [Task](https://taskfile.dev) build system. It is imported as a library and used to run the tasks defined in `Taskfile.yaml`. The main interfacing with Task happens in `v3/internal/commands/task.go`. +### Upgrading Taskfile + To check if there's an upgrade for Taskfile, run `wails3 task -version` and check against the Task website. @@ -171,7 +174,7 @@ wails3 task -version Make sure that all PRs have a ticket associated with them providing context to the change. If there is no ticket, please create one first. Ensure that all PRs have updated the CHANGELOG.md file with the changes made. The CHANGELOG.md file -is located in the `v3` directory. +is located in the `mkdocs-website/docs` directory. ## Misc Tasks diff --git a/mkdocs-website/docs/getting-started/installation.md b/mkdocs-website/docs/getting-started/installation.md index d9a3b56e8..168392666 100644 --- a/mkdocs-website/docs/getting-started/installation.md +++ b/mkdocs-website/docs/getting-started/installation.md @@ -4,7 +4,9 @@ To install the Wails CLI, ensure you have [Go 1.21+](https://go.dev/dl/) installed and run: ```shell -go install github.com/wailsapp/wails/v3/cmd/wails3@latest +git clone https://github.com/wailsapp/wails.git +cd wails/cmd/wails3 +go install ``` ## Supported Platforms diff --git a/mkdocs-website/docs/getting-started/next-steps.md b/mkdocs-website/docs/getting-started/next-steps.md index beffb8715..ad347cf06 100644 --- a/mkdocs-website/docs/getting-started/next-steps.md +++ b/mkdocs-website/docs/getting-started/next-steps.md @@ -15,6 +15,8 @@ go run . in the example directory. +The status of the examples is on the [roadmap](/roadmap). + ## Creating a new project To create a new project, you can use the `wails3 init` command. This will create diff --git a/mkdocs-website/docs/roadmap.md b/mkdocs-website/docs/roadmap.md index 69385590e..ac2fdf7f9 100644 --- a/mkdocs-website/docs/roadmap.md +++ b/mkdocs-website/docs/roadmap.md @@ -34,7 +34,7 @@ The main goal is to get most of the examples working on all platforms. | systray | W | W | | | video | | W | | | window | P | W | | -| wml | | W | | +| wml | W | W | | - Mac Dialogs work, however the file dialogs issue a warning that needs to be fixed. diff --git a/mkdocs-website/docs/whats-new.md b/mkdocs-website/docs/whats-new.md index fda676af6..cd4783f26 100644 --- a/mkdocs-website/docs/whats-new.md +++ b/mkdocs-website/docs/whats-new.md @@ -1,7 +1,7 @@ # What's new in v3? -!!! note The features that will be included in the v3 release may change from -this list. +!!! note + The features that will be included in the v3 release may change from this list. ## Multiple Windows @@ -311,24 +311,24 @@ An experimental feature to call runtime methods using plain html, similar to

Wails ML Demo

This application contains no Javascript!

- - + - - - - - - - - + + + + + + +
Hover over me
diff --git a/mkdocs-website/mkdocs.yml b/mkdocs-website/mkdocs.yml index 8c6b01bee..091d73fc7 100644 --- a/mkdocs-website/mkdocs.yml +++ b/mkdocs-website/mkdocs.yml @@ -5,7 +5,7 @@ edit_uri: edit/v3-alpha/mkdocs-website/docs/ site_url: https://v3alpha.wails.io theme: name: material -# custom_dir: overrides + custom_dir: overrides logo: assets/images/wails-logo-horizontal-dark.svg icon: repo: fontawesome/brands/github @@ -99,6 +99,7 @@ nav: - Introduction: development/introduction.md - Status: development/status.md - v3 Changes: development/changes.md + - Roadmap: roadmap.md - Change Log: changelog.md - Sponsor❤️: https://github.com/sponsors/leaanthony diff --git a/mkdocs-website/overrides/home.html b/mkdocs-website/overrides/home.html index dbd218650..0b86fd414 100644 --- a/mkdocs-website/overrides/home.html +++ b/mkdocs-website/overrides/home.html @@ -73,8 +73,13 @@ This site will be updated as we progress through the alpha and beta releases.

- v3 is a work in progress. Expect things to fail. Expect things to change. Expect the documentation to be wrong.

+
+

Warning

+

v3 alpha is a work in progress and not ready for production. Expect things to fail. Expect things to change. Expect the documentation to be wrong.

+

+
+

Status


@@ -83,15 +88,15 @@ - + - + - +
WindowsReady for alpha testingAll examples are working
MacReady for alpha testingMost examples are working
LinuxNot ready - still a work in progressSome examples are working


diff --git a/v3/examples/frameless/go.mod b/v3/examples/frameless/go.mod index bd4ee9196..edfa98f91 100644 --- a/v3/examples/frameless/go.mod +++ b/v3/examples/frameless/go.mod @@ -15,6 +15,7 @@ require ( github.com/go-git/go-billy/v5 v5.2.0 // indirect github.com/go-git/go-git/v5 v5.3.0 // indirect github.com/go-ole/go-ole v1.2.6 // indirect + github.com/godbus/dbus/v5 v5.1.0 // indirect github.com/google/uuid v1.3.0 // indirect github.com/imdario/mergo v0.3.12 // indirect github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect diff --git a/v3/examples/frameless/go.sum b/v3/examples/frameless/go.sum index 9147345a7..169c421b9 100644 --- a/v3/examples/frameless/go.sum +++ b/v3/examples/frameless/go.sum @@ -32,6 +32,8 @@ github.com/go-git/go-git/v5 v5.3.0 h1:8WKMtJR2j8RntEXR/uvTKagfEt4GYlwQ7mntE4+0GW github.com/go-git/go-git/v5 v5.3.0/go.mod h1:xdX4bWJ48aOrdhnl2XqHYstHbbp6+LFS4r4X+lNVprw= github.com/go-ole/go-ole v1.2.6 h1:/Fpf6oFPoeFik9ty7siob0G6Ke8QvQEuVcuChpwXzpY= github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0= +github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk= +github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38= github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= @@ -99,8 +101,7 @@ github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXf github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= -github.com/wailsapp/go-webview2 v1.0.8 h1:hyoFPlMSfb/NM64wuVbgBaq1MASJjqsSUYhN+Rbcr9Y= -github.com/wailsapp/go-webview2 v1.0.8/go.mod h1:Uk2BePfCRzttBBjFrBmqKGJd41P6QIHeV9kTgIeOZNo= +github.com/wailsapp/go-webview2 v1.0.9 h1:lrU+q0cf1wgLdR69rN+ZnRtMJNaJRrcQ4ELxoO7/xjs= github.com/wailsapp/go-webview2 v1.0.9/go.mod h1:Uk2BePfCRzttBBjFrBmqKGJd41P6QIHeV9kTgIeOZNo= github.com/wailsapp/mimetype v1.4.1 h1:pQN9ycO7uo4vsUUuPeHEYoUkLVkaRntMnHJxVwYhwHs= github.com/wailsapp/mimetype v1.4.1/go.mod h1:9aV5k31bBOv5z6u+QP8TltzvNGJPmNJD4XlAL3U+j3o= @@ -148,5 +149,6 @@ gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU= gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=