docs: Enable markdown linting and spell checking with related fixes

.vsts-ci.yml

@@ -1,22 +1,57 @@
+trigger:
+  branches:
+    include:
+      - main
+      - release/stable/*
+      - feature/*
 
-jobs:
-- template: .vsts-ci-packages.yml
-  parameters:
-    jobName: Packages
+pr:
+  branches:
+    include:
+      - main
+      - release/stable/*
+      - feature/*
 
-- template: .vsts-ci-linux.yml
-  parameters:
-    jobName: Linux_Tests
-    linux_container: unoplatform/wasm-build:3.0
+stages:
+- stage: Determine_Changes
+  displayName: Determine Changes
+  jobs:
+  - template: build/ci/stage-determine-changes.yml
 
-- template: .vsts-ci-windows-tests.yml
-  parameters:
-    jobName: Windows_Tests
-    linux_container: unoplatform/wasm-build:3.0
+- stage: Docs_Validations
+  displayName: Docs Validations
+  dependsOn: Determine_Changes
+  # Trigger this stage when docs files are changed
+  condition: or(eq(dependencies.Determine_Changes.outputs['evaluate_changes.DetermineChanges.docsOnly'], 'true'), eq(dependencies.Determine_Changes.outputs['evaluate_changes.DetermineChanges.mixedChanges'], 'true'))
+  jobs:
+  - template: build/ci/stage-docs-validations.yml
 
-- template: .vsts-ci-macos.yml
-  parameters:
-    jobName: macOS_Tests
-    vmImage: macOS-12
+- stage: Packages
+  displayName: Packages
+  dependsOn: Determine_Changes
+  # Don't trigger this stage if only docs files are changed
+  condition: ne(dependencies.Determine_Changes.outputs['evaluate_changes.DetermineChanges.docsOnly'], 'true')
+  jobs:
+  - template: build/ci/stage-build-packages.yml
+    parameters:
+      jobName: Packages
 
-- template: .vsts-ci-wsl-tests.yml
+- stage: Build_Tests
+  displayName: Build Tests
+  dependsOn: Determine_Changes
+  # Don't trigger this stage if only docs files are changed
+  condition: ne(dependencies.Determine_Changes.outputs['evaluate_changes.DetermineChanges.docsOnly'], 'true')
+  jobs:
+    - template: build/ci/stage-build-linux-tests.yml
+      parameters:
+        jobName: Linux_Tests
+        linux_container: unoplatform/wasm-build:3.0
+    - template: build/ci/stage-build-windows-tests.yml
+      parameters:
+        jobName: Windows_Tests
+        linux_container: unoplatform/wasm-build:3.0
+    - template: build/ci/stage-build-macos-tests.yml
+      parameters:
+        jobName: macOS_Tests
+        vmImage: macOS-12
+    - template: build/ci/stage-build-wsl-tests.yml

License.md

@@ -1,6 +1,7 @@
+<!-- markdownlint-disable MD041 -->
 Copyright (c) Uno Platform Inc
 
-All rights reserved. 
+All rights reserved.
 
 # Apache 2.0 License
 
@@ -204,4 +205,4 @@ All rights reserved.
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

Readme.md

@@ -1,6 +1,6 @@
 # Uno.Wasm.Bootstrap
 
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/unoplatform/Uno.Wasm.Bootstrap) 
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/unoplatform/Uno.Wasm.Bootstrap)
 
 Uno.Wasm.Bootstrap provides a simple way to package C# .NET code, and run it from a compatible browser environment.
 
@@ -13,6 +13,7 @@ This package only provides the bootstrapping features to run a .NET assembly and
 This package is based on the excellent work from @praeclarum's [OOui Wasm MSBuild task](https://github.com/praeclarum/Ooui).
 
 ## Documentation
+
 - [Using the bootstrapper](doc/using-the-bootstrapper.md)
 - [Debugger support](doc/debugger-support.md)
 - [Deploy and publish](doc/deploy-and-publish.md)
@@ -35,11 +36,11 @@ This package is based on the excellent work from @praeclarum's [OOui Wasm MSBuil
   - [Profiling](doc/features-profiling.md)
   - [Node JS](doc/features-node-js.md)
   - [Nuget package overrides](doc/features-nuget-package-overrides.md)
-  - [Prefechting](doc/features-prefetch.md)
+  - [Prefetching](doc/features-prefetch.md)
   - [PWA Support](doc/features-pwa.md)
   - [4GB Support](doc/features-4gb.md)
   - [HttpRequestMessage Extensions](doc/features-httprequestmessage-extensions.md)
-  - [Assemblies obfuscation](doc/features-obfsucation.md)
+  - [Assemblies obfuscation](doc/features-obfuscation.md)
 - Tools
   - [Uno Version Checker](doc/features-version-checker.md)
 - [Contributing](doc/contributing.md)

build/ci/.markdownlint.json

@@ -0,0 +1,9 @@
+{
+	"default": true,
+	"line-length": false,
+	"commands-show-output": false,
+	"no-bare-urls": false,
+	"no-inline-html": false,
+	"no-duplicate-heading": false,
+	"MD051": false
+}

build/ci/cspell.json

@@ -0,0 +1,210 @@
+{
+	"version": "0.2",
+	"language": "en",
+	"words": [
+		"Avalonia",
+		"ambiently",
+		"binlog",
+		"Blazor",
+		"blockquotes",
+		"Bootstrapper",
+		"brotli",
+		"browsersync",
+		"bytecode",
+		"Callout",
+		"chatops",
+		"codebases",
+		"Codespace",
+		"Codespaces",
+		"Contoso",
+		"Cupertino",
+		"customizability",
+		"databinding",
+		"datacontext",
+		"datagrid",
+		"devs",
+		"Dismissable",
+		"Docfx",
+		"ellipsize",
+		"Expando",
+		"flyouts",
+		"Framebuffer",
+		"Gamepad",
+		"gamepads",
+		"Geolocation",
+		"globbing",
+		"Gyrometer",
+		"Hanja",
+		"hectopascals",
+		"Inlines",
+		"keychain",
+		"laggy",
+		"layouter",
+		"layouting",
+		"Listview",
+		"LLRM",
+		"mergeable",
+		"MSAL",
+		"msbuild",
+		"MVUX",
+		"MVVM",
+		"NETSDK",
+		"netstandard",
+		"oidc",
+		"Omnisharp",
+		"overscroll",
+		"Packt",
+		"parameterless",
+		"pickable",
+		"Pluralsight",
+		"POSIX",
+		"reentrantly",
+		"Resizetizer",
+		"resw",
+		"roadmap",
+		"sandboxed",
+		"Segoe",
+		"Silverlight",
+		"Skia",
+		"skiasharp",
+		"Storyboarded",
+		"struct",
+		"Syncfusion",
+		"templatable",
+		"templating",
+		"timespan",
+		"Tizen",
+		"TLDR",
+		"toolkits",
+		"triaging",
+		"UI's",
+		"unmanaged",
+		"Uno's",
+		"unoplatform",
+		"UWP's",
+		"VSIX",
+		"walkthrough",
+		"WEBASSEMBLY",
+		"Haptics",
+		"subfolders",
+		"interoperating",
+		"bitcode",
+		"subresource",
+		"SIMD"
+	],
+	"ignoreWords": [
+		"ADAL",
+		"addin",
+		"AEHD",
+		"appsettings",
+		"Authenticode",
+		"automagically",
+		"Divio's",
+		"emcc",
+		"emscripten",
+		"Findlay",
+		"Flatpickr",
+		"Giesel",
+		"GNSS",
+		"GPIO",
+		"Grigorik",
+		"hdpi",
+		"Headered",
+		"Hoefling",
+		"HRESULT",
+		"Icaza",
+		"IDBFS",
+		"Ilya",
+		"Infragistics",
+		"jonathanpeppers's",
+		"Krueger",
+		"libgtk",
+		"Liu's",
+		"Logpoints",
+		"macios",
+		"Matteo",
+		"McCaffrey",
+		"mdpi",
+		"Mergify",
+		"mlaunch",
+		"muxc",
+		"netstd",
+		"nventive",
+		"odel",
+		"Onoh",
+		"pdate",
+		"Ronica",
+		"Serilog",
+		"Singh",
+		"slnf",
+		"Stetho",
+		"Talkin",
+		"UADO",
+		"Udemy",
+		"UNOB",
+		"unpackaged",
+		"winappsdk",
+		"winui",
+		"xhdpi",
+		"xxhdpi",
+		"xxxhdpi",
+		"Yowza",
+		"wslpath",
+		"httprequestmessage",
+		"praeclarum's"
+	],
+	"patterns": [
+		{
+			"name": "Markdown uid",
+			"pattern": "^(?=uid:).*$",
+			"description": ""
+		},
+		{
+			"name": "Markdown links",
+			"pattern": "\\((.*)\\)",
+			"description": ""
+		},
+		{
+			"name": "Markdown code blocks",
+			"pattern": "/^(\\s*`{3,}).*[\\s\\S]*?^\\1/gmx",
+			"description": "Taken from the cSpell example at https://cspell.org/configuration/patterns/#verbose-regular-expressions"
+		},
+		{
+			"name": "Inline code blocks",
+			"pattern": "\\`([^\\`\\r\\n]+?)\\`",
+			"description": "https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex"
+		},
+		{
+			"name": "Link contents",
+			"pattern": "\\<a(.*)\\>",
+			"description": ""
+		},
+		{
+			"name": "Snippet references",
+			"pattern": "-- snippet:(.*)",
+			"description": ""
+		},
+		{
+			"name": "Snippet references 2",
+			"pattern": "\\<\\[sample:(.*)",
+			"description": "another kind of snippet reference"
+		},
+		{
+			"name": "Multi-line code blocks",
+			"pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm"
+		}
+	],
+	"ignoreRegExpList": [
+		"Markdown uid",
+		"Markdown links",
+		"Markdown code blocks",
+		"Inline code blocks",
+		"Link contents",
+		"Snippet references",
+		"Snippet references 2",
+		"Multi-line code blocks"
+	],
+	"ignorePaths": [
+		"../doc/index.md"
+	]
+}

.vsts-ci-linux.yml → build/ci/stage-build-linux-tests.yml

@@ -22,8 +22,8 @@ jobs:
   - checkout: self
     clean: true
 
-  - template: build/ci/gitversion.yml
-  - template: build/ci/dotnet-install.yml
+  - template: gitversion.yml
+  - template: dotnet-install.yml
 
   - task: UseDotNet@2
     displayName: 'Use .NET SDK'

.vsts-ci-macos.yml → build/ci/stage-build-macos-tests.yml

@@ -13,8 +13,8 @@ jobs:
     SourceLinkEnabled: false
 
   steps:
-  - template: build/ci/gitversion.yml
-  - template: build/ci/dotnet-install.yml
+  - template: gitversion.yml
+  - template: dotnet-install.yml
 
   - task: UseDotNet@2
     displayName: 'Use .NET SDK'

.vsts-ci-packages.yml → build/ci/stage-build-packages.yml

@@ -18,8 +18,8 @@ jobs:
       version: 8.0.100
       includePreviewVersions: true
 
-  - template: build/ci/gitversion.yml
-  - template: build/ci/dotnet-install.yml
+  - template: gitversion.yml
+  - template: dotnet-install.yml
 
   - bash: |
       npm install -g [email protected]

.vsts-ci-windows-tests.yml → build/ci/stage-build-windows-tests.yml

@@ -19,8 +19,8 @@ jobs:
   - checkout: self
     clean: true
 
-  - template: build/ci/gitversion.yml
-  - template: build/ci/dotnet-install.yml
+  - template: gitversion.yml
+  - template: dotnet-install.yml
 
   - task: UseDotNet@2
     displayName: 'Use .NET SDK'