Update docs and changelog

* docs: sync documents

* docs: fix document escape syntax

.all-contributorsrc

@@ -655,7 +655,6 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/14013111?v=4",
       "profile": "https://github.com/GargantuaX",
       "contributions": [
-        "doc",
         "financial"
       ]
     },
@@ -1310,6 +1309,45 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "Maicarons2022",
+      "name": "Maicarons J",
+      "avatar_url": "https://avatars.githubusercontent.com/u/101958587?v=4",
+      "profile": "http://mai.car.ons",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "KiddoV",
+      "name": "kiddov",
+      "avatar_url": "https://avatars.githubusercontent.com/u/28552977?v=4",
+      "profile": "https://github.com/KiddoV",
+      "contributions": [
+        "doc",
+        "financial",
+        "test",
+        "ideas"
+      ]
+    },
+    {
+      "login": "Ilshidur",
+      "name": "Nicolas Coutin",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6564012?v=4",
+      "profile": "https://nicolas-coutin.com/",
+      "contributions": [
+        "financial"
+      ]
+    },
+    {
+      "login": "ParvinEyvazov",
+      "name": "Parvin Eyvazov",
+      "avatar_url": "https://avatars.githubusercontent.com/u/32189770?v=4",
+      "profile": "https://github.com/ParvinEyvazov",
+      "contributions": [
+        "doc"
+      ]
     }
   ],
   "contributorsPerLine": 8,

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,7 +1,7 @@
 name: Bug Report
 description: Create a report to help us improve
 # title: ""
-labels: ["bug"]
+labels: ["Bug"]
 
 body:
   - type: markdown

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
-blank_issues_enabled: false
+blank_issues_enabled: true
 contact_links:
   - name: GitHub Community Discussions
     url: https://github.com/wailsapp/wails/discussions

.github/ISSUE_TEMPLATE/documentation.yml

@@ -1,7 +1,7 @@
 name: Documentation
 description: Report an issue related to documentation.
 # title: ""
-labels: ["documentation"]
+labels: ["Documentation"]
 
 body:
   - type: markdown
@@ -12,6 +12,7 @@ body:
         - Log undocumented APIs
         - Update link
         - Documentation other than non-project code
+        - Add new language
 
         If you followed the documentation but things don't work, take some time to consider if it's the documentation or the code that's wrong. In the latter, prefer using the "[Bug Report](https://github.com/wailsapp/wails/issues/new?assignees=&labels=bug&template=bug_report.yml)" template.
 
@@ -19,7 +20,7 @@ body:
     attributes:
       label: Have you read the Documentation Contribution Guidelines?
       options:
-        - label: I have read the [Documentation Contribution Guidelines](https://wails.io/docs/next/contributing/documenting).
+        - label: I have read the [Documentation Contribution Guidelines](https://wails.io/community-guide#ways-of-contributing).
           required: true
 
   - type: textarea

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,7 +1,7 @@
 name: Feature request
 description: Suggest an idea for this project
 # title: ""
-labels: ["enhancement"]
+labels: ["Enhancement"]
 
 body:
   - type: markdown

.github/stale.yml

@@ -10,7 +10,7 @@ exemptLabels:
   - inprogress
   - "Selected For Development"
 # Label to use when marking an issue as stale
-staleLabel: wontfix
+staleLabel: "Wont Fix"
 # Comment to post when marking an issue as stale. Set to `false` to disable
 markComment: >
   This issue has been automatically marked as stale because it has not had

.github/workflows/build_and_test.yml

@@ -0,0 +1,69 @@
+name: Build + Test
+
+on:
+  push:
+    branches: [ release/*, master ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Run Go Tests
+    if: github.repository == 'wailsapp/wails'
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        go-version: [ 1.18, 1.19 ]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install linux dependencies
+        if: matrix.os == 'ubuntu-latest'
+        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config
+
+      - name: Set up Go 1.18
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Run tests
+        run: go test -v ./...
+
+  test_templates:
+    name: Test Templates
+    needs: test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        template: [ svelte, svelte-ts, vue, vue-ts, react, react-ts, preact, preact-ts, lit, lit-ts, vanilla, vanilla-ts, plain ]
+        go-version: [ 1.18, 1.19 ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Build Wails CLI
+        run: |
+          cd ./v2/cmd/wails
+          go install
+          wails -help
+
+      - name: Install linux dependencies
+        if: matrix.os == 'ubuntu-latest'
+        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config
+
+      - name: Generate template '${{ matrix.template }}'
+        run: |
+          mkdir -p ./test-${{ matrix.template }}
+          cd ./test-${{ matrix.template }}
+          wails init -n ${{ matrix.template }} -t ${{ matrix.template }} -ci
+          cd ${{ matrix.template }}
+          wails build -v 2

.github/workflows/check_docs.yml

@@ -0,0 +1,25 @@
+name: Check Docs
+on:
+  pull_request:
+    branches: [ 'feature/*' ]
+
+jobs:
+  docs:
+    name: Website Updated
+    if: github.repository == 'wailsapp/wails'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Verify Changed files
+        uses: tj-actions/verify-changed-files@v11.1
+        id: verify-changed-files
+        with:
+          files: |
+            website/**/*.mdx
+            website/**/*.md
+
+      - name: Run step only when files change.
+        if: steps.verify-changed-files.outputs.files_changed != 'true'
+        run: |
+          echo "Feature branch does not contain any changes to the website."

.github/workflows/deploy-website-to-wails.top-mirror.yml

@@ -1,50 +0,0 @@
-name: Sync upstream branch and deploy mirror | 同步上游分支并部署镜像
-
-on:
-  schedule:
-    - cron: "0 8,20 * * *"
-  workflow_dispatch:
-
-jobs:
-  build-and-deploy:
-    name: Automatic deployment | 自动部署
-    runs-on: ubuntu-latest
-    if: github.repository == 'misitebao/wails'
-
-    steps:
-      - name: Checkout | 切换到部署分支
-        uses: actions/checkout@v2
-        with:
-          ref: "master"
-          submodules: true
-          fetch-depth: 0
-
-      - name: Setup Git | 设置Git
-        run: |
-          git config --local user.email "i@misitebao.com"
-          git config --local user.name "misitebao"
-
-      - name: Add remote upstream repository and sync | 添加远程上游仓库并同步
-        run: |
-          git remote add upstream https://github.com/wailsapp/wails
-          git pull -v --progress --no-rebase "upstream" master
-
-      - name: Push | 推送
-        uses: ad-m/github-push-action@master
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: ${{ github.ref }}
-
-      - name: Build Site | 构建网站
-        run: |
-          cd website &&
-          npm install && npm run build
-
-      - name: Deploy to Server | 部署到服务器
-        uses: hengkx/ssh-deploy@v1.0.1
-        with:
-          HOST: ${{ secrets.DEPLOY_HOST }}
-          USERNAME: ${{ secrets.DEPLOY_HOST_USER }}
-          PASSWORD: ${{ secrets.DEPLOY_HOST_PASSWORD }}
-          SOURCE: "website/build"
-          TARGET: "/www/wwwroot/wails.top"

.github/workflows/generate-sponsor-image.yml

@@ -0,0 +1,34 @@
+name: Generate Sponsor Image
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  update-sponsors:
+    runs-on: ubuntu-latest
+    if: github.repository == 'wailsapp/wails'
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+
+      - name: Update sponsors
+        run: cd scripts/sponsors && chmod 755 ./generate-sponsor-image.sh && ./generate-sponsor-image.sh
+        env:
+          SPONSORKIT_GITHUB_TOKEN: ${{ secrets.SPONSORS_TOKEN }}
+          SPONSORKIT_GITHUB_LOGIN: wailsapp
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: "chore: update sponsors.svg"
+          add-paths: "website/static/img/sponsors.svg"
+          title: Update Sponsor Image
+          body: Generated new image
+          branch: update-sponsors
+          delete-branch: true

.github/workflows/label-sponsors.yml

@@ -0,0 +1,15 @@
+name: Label sponsors
+on:
+  pull_request:
+    types: [ opened ]
+  issues:
+    types: [ opened ]
+jobs:
+  build:
+    name: is-sponsor-label
+    if: github.repository == 'wailsapp/wails'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JasonEtco/is-sponsor-label-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/latest-pre.yml

@@ -1,34 +0,0 @@
-name: latest pre-release
-on:
-  push:
-    branches:
-      - develop
-    tags:
-      - '**-pre**'
-jobs:
-
-  build:
-    name: Test Build Latest Pre-Release
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest, macOS-latest]
-    steps:
-
-    - name: Set up Go 1.16
-      uses: actions/setup-go@v1
-      with:
-        go-version: 1.16
-      id: go
-
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v1
-
-    - name: Get dependencies
-      run: |
-        go get -v -d ./...
-    - name: Build
-      run: go build -v ./cmd/wails
-
-    - name: Test
-      run: ./wails version

.github/workflows/pr.yml

@@ -1,32 +1,43 @@
-name: pr
+name: PR Checks
 on:
   pull_request:
-    branches:
-    - develop
-jobs:
+  pull_request_review:
+    types: [ submitted ]
 
-  build:
-    name: Test Build PR
+jobs:
+  check_branch_name:
+    runs-on: ubuntu-latest
+    if: github.repository == 'wailsapp/wails'
+    name: Check branch name
+    steps:
+      - run: |
+          if ! [[ "$(echo ${GITHUB_HEAD_REF} | cut -d "/" -f1)" =~ (feature|bugfix|release|chore) ]]; then
+            echo "PRs are only accepted for branches starting with: feature/, bugfix/, chore/ or release/"
+            exit 1
+          fi
+        shell: bash
+
+  test:
+    name: Run Go Tests
     runs-on: ${{ matrix.os }}
+    if: github.event.review.state == 'approved'
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macOS-latest]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        go-version: [ 1.18, 1.19 ]
+
     steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
 
-    - name: Set up Go 1.16
-      uses: actions/setup-go@v1
-      with:
-        go-version: 1.16
-      id: go
+      - name: Install linux dependencies
+        if: matrix.os == 'ubuntu-latest'
+        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config
 
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v1
+      - name: Set up Go 1.18
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
 
-    - name: Get dependencies
-      run: |
-        go get -v -d ./...
-    - name: Build
-      run: go build -v ./cmd/wails
-
-    - name: Test
-      run: ./wails version
+      - name: Run tests
+        run: go test -v ./...

.github/workflows/projects.yml

@@ -0,0 +1,17 @@
+name: Update Project
+
+on:
+  project_card:
+    types: [ moved ]
+
+jobs:
+  projectcardautolabel_job:
+    runs-on: ubuntu-latest
+    if: github.repository == 'wailsapp/wails'
+    steps:
+      - name: Run ProjectCard AutoLabel
+        id: runprojectcardautolabel
+        uses: Matticusau/projectcard-autolabel@v1.0.0
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          autolabel-config: '[{"column": "TODO", "add_labels":["TODO"], "remove_labels":["In Progress", "Ready For Testing"]},{"column":"In progress", "add_labels":["In Progress"], "remove_labels":["TODO", "Ready For Testing"]},{"column":"In review", "add_labels":["Ready For Testing"], "remove_labels":["TODO", "In Progress"]}, {"column":"Done", "add_labels":["Done"], "remove_labels":["TODO", "In Progress", "Ready For Testing"]}]'

.github/workflows/push-to-crowdin.yml

@@ -0,0 +1,38 @@
+name: Push files to Crowdin
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  docs:
+    name: Push files to Crowdin
+    if: github.repository == 'wailsapp/wails'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Verify Changed files
+        uses: tj-actions/verify-changed-files@v11.1
+        id: verify-changed-files
+        with:
+          files: |
+            website/**/*.mdx
+            website/**/*.md
+            website/**/*.json
+
+      - name: Set node
+        if: steps.verify-changed-files.outputs.files_changed != 'true'
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+
+      - name: Push files
+        env:
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
+        run: |
+          cd website
+          corepack enable
+          pnpm install
+          pnpm run crowdin push -b master

.github/workflows/release.yml

@@ -1,34 +0,0 @@
-name: release
-on:
-  push:
-    branches:
-    - master
-    tags:
-    - '!**pre**'
-jobs:
-
-  build:
-    name: Test Build Latest Release
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest, macOS-latest]
-    steps:
-
-    - name: Set up Go 1.16
-      uses: actions/setup-go@v1
-      with:
-        go-version: 1.16
-      id: go
-
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v1
-
-    - name: Get dependencies
-      run: |
-        go get -v -d ./...
-    - name: Build
-      run: go build -v ./cmd/wails
-
-    - name: Test
-      run: ./wails version

.github/workflows/runtime.yml

@@ -10,7 +10,7 @@ jobs:
     name: Rebuild the runtime
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@v2
         with:
           node-version: 14.17.6

.github/workflows/test_js.yml

@@ -0,0 +1,32 @@
+name: Test JS
+
+on:
+  push:
+    branches: [ release/*, master ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Run JS Tests
+    if: github.repository == 'wailsapp/wails'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+        working-directory: v2/internal/frontend/runtime
+
+      - name: Run tests
+        run: npm test
+        working-directory: v2/internal/frontend/runtime

.gitignore

@@ -27,8 +27,7 @@ v2/pkg/parser/testproject/frontend/wails
 v2/test/kitchensink/frontend/public
 v2/test/kitchensink/build/darwin/desktop/kitchensink
 v2/test/kitchensink/frontend/package.json.md5
-/v2/internal/ffenestri/windows/test/cmake-build-debug/
-!v2/internal/ffenestri/windows/x64/webview2.dll
-!v2/internal/ffenestri/windows/x64/WebView2Loader.dll
 .idea/
 v2/cmd/wails/internal/commands/initialise/templates/testtemplates/
+.env
+/website/static/img/.cache.json

.vscode/launch.json

@@ -1,48 +0,0 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Test cmd package",
-      "type": "go",
-      "request": "launch",
-      "mode": "test",
-      "program": "${workspaceFolder}/cmd/"
-    },
-    {
-      "name": "Wails Init",
-      "type": "go",
-      "request": "launch",
-      "mode": "auto",
-      "program": "${workspaceFolder}/cmd/wails/main.go",
-      "env": {},
-      "cwd": "/tmp",
-      "args": [
-        "init",
-        "-name",
-        "runtime",
-        "-dir",
-        "runtime",
-        "-output",
-        "runtime",
-        "-template",
-        "vuebasic"
-      ]
-    },
-    {
-      "name": "Wails Update Pre",
-      "type": "go",
-      "request": "launch",
-      "mode": "auto",
-      "program": "${workspaceFolder}/cmd/wails/main.go",
-      "env": {},
-      "cwd": "/tmp",
-      "args": [
-        "update",
-        "-pre"
-      ]
-    }
-  ]
-}