From 1ec315943389dbb7d14b5384f83ce4b8a4379ce2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Laban?= Date: Tue, 28 May 2024 10:56:22 -0400 Subject: [PATCH] chore: Add docs uids --- doc/debugger-support.md | 4 ++++ doc/deploy-and-publish.md | 3 +++ doc/features-4gb.md | 4 ++++ doc/features-additional-files.md | 4 ++++ doc/features-dependency-management.md | 4 ++++ doc/features-embedded.mode.md | 3 +++ doc/features-environment-variables.md | 4 ++++ doc/features-httprequestmessage-extensions.md | 4 ++++ doc/features-interop.md | 1 + doc/features-linker-opts.md | 4 ++++ doc/features-memory-corruption-troubleshooting.md | 4 ++++ doc/features-module-linking.md | 4 ++++ doc/features-node-js.md | 4 ++++ doc/features-nuget-package-overrides.md | 4 ++++ doc/features-obfsucation.md | 4 ++++ doc/features-pre-compression.md | 4 ++++ doc/features-prefetch.md | 4 ++++ doc/features-pwa.md | 4 +++- doc/features-security.md | 3 ++- doc/features-simd.md | 4 ++++ doc/features-splash-screen.md | 4 ++++ doc/features-threading.md | 4 ++++ doc/features-version-checker.md | 4 ++++ doc/linker-configuration.md | 4 ++++ doc/runtime-execution-modes.md | 1 + doc/troubleshooting.md | 4 ++++ doc/using-the-bootstrapper.md | 4 ++++ 27 files changed, 97 insertions(+), 2 deletions(-) diff --git a/doc/debugger-support.md b/doc/debugger-support.md index b0882136d..c9f7c8a70 100644 --- a/doc/debugger-support.md +++ b/doc/debugger-support.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.Debugger +--- + ## .NET for WebAssembly Debugger Support Debugging is supported through the integration of a .NET Core CLI component, which acts as a static files server, as well as a debugger proxy for Chrome (other browsers are not supported). diff --git a/doc/deploy-and-publish.md b/doc/deploy-and-publish.md index d68e22124..18b74fffe 100644 --- a/doc/deploy-and-publish.md +++ b/doc/deploy-and-publish.md @@ -1,3 +1,6 @@ +--- +uid: UnoWasmBootstrap.Features.Publish +--- ## Publishing the build results The easiest way to publish the build results is to use the Visual Studio publish menu on your project. This will allow to use all the features provided by the standard experience, as described in the [Deploy to Azure App Service](https://docs.microsoft.com/en-us/visualstudio/deployment/quickstart-deploy-to-azure?view=vs-2017). diff --git a/doc/features-4gb.md b/doc/features-4gb.md index 78a110c3d..fb737e392 100644 --- a/doc/features-4gb.md +++ b/doc/features-4gb.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.4gb +--- + ### 4GB memory support The support for 4GB memory space is available by adding the following configuration: diff --git a/doc/features-additional-files.md b/doc/features-additional-files.md index 25db00ae5..394114956 100644 --- a/doc/features-additional-files.md +++ b/doc/features-additional-files.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.AdditionalFiles +--- + ### Index.html content override The msbuild property `WasmShellIndexHtmlPath` can be used to specify the path of a project-specific `index.html` file. diff --git a/doc/features-dependency-management.md b/doc/features-dependency-management.md index 448e0ec3d..a66141996 100644 --- a/doc/features-dependency-management.md +++ b/doc/features-dependency-management.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.DependencyManagement +--- + ### Dependency management The Uno Bootstrapper uses RequireJS for dependency management, allowing for dependencies to be resolved in a stable manner. diff --git a/doc/features-embedded.mode.md b/doc/features-embedded.mode.md index 0ccd0d1a0..e3062f7fc 100644 --- a/doc/features-embedded.mode.md +++ b/doc/features-embedded.mode.md @@ -1,3 +1,6 @@ +--- +uid: UnoWasmBootstrap.Features.EmbeddedMode +--- ### Browser Embedded mode diff --git a/doc/features-environment-variables.md b/doc/features-environment-variables.md index b024bc71a..0a25dcde1 100644 --- a/doc/features-environment-variables.md +++ b/doc/features-environment-variables.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.EnvironmentVariables +--- + ## Environment variables Mono provides the ability to configure some features at initialization, such as logging or GC. diff --git a/doc/features-httprequestmessage-extensions.md b/doc/features-httprequestmessage-extensions.md index 90ad6daec..8f7ecfa3e 100644 --- a/doc/features-httprequestmessage-extensions.md +++ b/doc/features-httprequestmessage-extensions.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.HttpRequestExtensions +--- + ## Support for HttpRequestMessage Extensions As of .NET 7, the BCL [does not provide a way](https://github.com/dotnet/runtime/issues/77904) to set the `fetch` API options for a `HttpRequestMessage`. This feature is provided as part of Blazor, which cannot be integrated into Uno Bootstrapper Applications at this time. diff --git a/doc/features-interop.md b/doc/features-interop.md index 46eb537f5..1e0c51c96 100644 --- a/doc/features-interop.md +++ b/doc/features-interop.md @@ -1,6 +1,7 @@ --- uid: Uno.Wasm.Bootstrap.JSInterop --- + ## Interoperating with Javascript The Uno boostrapper provides the ability to interoperate from and to Javascript from .NET. diff --git a/doc/features-linker-opts.md b/doc/features-linker-opts.md index 878c099cc..cebd6e071 100644 --- a/doc/features-linker-opts.md +++ b/doc/features-linker-opts.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.LinkerOpts +--- + ## Emscripten Linker optimizations flags When building with AOT or using static linking of bitcode files, the emscripten linker step is enabled and runs optimizations on the generated code. diff --git a/doc/features-memory-corruption-troubleshooting.md b/doc/features-memory-corruption-troubleshooting.md index aa717fd1f..6ff5d559b 100644 --- a/doc/features-memory-corruption-troubleshooting.md +++ b/doc/features-memory-corruption-troubleshooting.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.MemoryTroubleshooting +--- + ## Native memory troubleshooting To enable native memory troubleshooting, it is possible to use [LLVM's sanitizer](https://emscripten.org/docs/debugging/Sanitizers.html) feature. diff --git a/doc/features-module-linking.md b/doc/features-module-linking.md index 7354ba10b..4ed5b57e5 100644 --- a/doc/features-module-linking.md +++ b/doc/features-module-linking.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.ModuleLinking +--- + ### WebAssembly Module Linking support #### Static Linking overview diff --git a/doc/features-node-js.md b/doc/features-node-js.md index 3d91b497b..d1a48a1b6 100644 --- a/doc/features-node-js.md +++ b/doc/features-node-js.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.NodeJS +--- + ### Node.js support The bootstrapper supports having a project loaded as part of a node application. To do so: diff --git a/doc/features-nuget-package-overrides.md b/doc/features-nuget-package-overrides.md index 2aa71ff13..89a93910c 100644 --- a/doc/features-nuget-package-overrides.md +++ b/doc/features-nuget-package-overrides.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.PackageOverrides +--- + ### Nuget package runtime overrides By default, when presented with an assembly present in both the runtime and a nuget package, the bootstrapper will favor the runtime's version of the assembly. This is generally required to avoid internal consistency errors with the runtime. diff --git a/doc/features-obfsucation.md b/doc/features-obfsucation.md index 0f60050b6..ca2b39563 100644 --- a/doc/features-obfsucation.md +++ b/doc/features-obfsucation.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.Obfuscation +--- + ## Assemblies obfuscation The Bootstrapper provides a way to obfuscate served assemblies in order to avoid incorrect flagging by anti-virus and firewalls. diff --git a/doc/features-pre-compression.md b/doc/features-pre-compression.md index 954934102..b08ba86f5 100644 --- a/doc/features-pre-compression.md +++ b/doc/features-pre-compression.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.PreCompression +--- + ### Pre-Compression support Pre-compression has two modes: diff --git a/doc/features-prefetch.md b/doc/features-prefetch.md index 0588740ba..d23ce599f 100644 --- a/doc/features-prefetch.md +++ b/doc/features-prefetch.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.Prefetch +--- + ### Support for Content prefetching The `WashShellGeneratePrefetchHeaders` controls the generation of `` nodes in the index.html header. diff --git a/doc/features-pwa.md b/doc/features-pwa.md index f9725bf99..116f352bf 100644 --- a/doc/features-pwa.md +++ b/doc/features-pwa.md @@ -1,4 +1,6 @@ - +--- +uid: UnoWasmBootstrap.Features.PWA +--- ### Support for PWA Manifest File A **Progressive Web App** manifest link definition can be added to the index.html file's head: diff --git a/doc/features-security.md b/doc/features-security.md index 9fd5270d4..7b4e0ba7c 100644 --- a/doc/features-security.md +++ b/doc/features-security.md @@ -1,6 +1,7 @@ --- -uid: Uno.Wasm.Bootstrap.Security +uid: Uno.Wasm.Bootstrap.Features.Security --- + # Security ## CSP Support diff --git a/doc/features-simd.md b/doc/features-simd.md index 864bcbd2c..6aac14ff3 100644 --- a/doc/features-simd.md +++ b/doc/features-simd.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.Overview +--- + ## Support for SIMD Starting from .NET 7, support for SIMD is available through the following property: diff --git a/doc/features-splash-screen.md b/doc/features-splash-screen.md index fb6b660e3..f28765e7f 100644 --- a/doc/features-splash-screen.md +++ b/doc/features-splash-screen.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.SplashScreen +--- + ## Splash screen customization The default configuration for the bootstrapper is to show the Uno Platform logo. This can be changed, along with the background color and progress bar color by doing the following: diff --git a/doc/features-threading.md b/doc/features-threading.md index 3dddfa82a..ef9c1b4f0 100644 --- a/doc/features-threading.md +++ b/doc/features-threading.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.Threading +--- + ## Support for WebAssembly Threads Starting from .NET 7, experimental support for [WebAssembly threads](https://github.com/WebAssembly/threads/blob/master/proposals/threads/Overview.md) has been included. This support is provided by the boostrapper 7.0 and later, for interpreter and AOT modes. The following documentation explains how to enable threading. diff --git a/doc/features-version-checker.md b/doc/features-version-checker.md index ee66a6b88..465ab6aab 100644 --- a/doc/features-version-checker.md +++ b/doc/features-version-checker.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.VersionChecker +--- + # Uno.Wasm.VersionChecker This is a tool to extract the version of _dotnet assemblies_ used on a Uno.UI application. Should also work with most applications built on _Uno Bootstrapper_. diff --git a/doc/linker-configuration.md b/doc/linker-configuration.md index 49cd4d0d8..5583877c5 100644 --- a/doc/linker-configuration.md +++ b/doc/linker-configuration.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.LinkerConfig +--- + ## Linker configuration The .NET tooling uses the [ILLinker](https://github.com/mono/linker/tree/master/), and can be configured using a linker directives file. diff --git a/doc/runtime-execution-modes.md b/doc/runtime-execution-modes.md index e5b57a65a..a93a2ca3b 100644 --- a/doc/runtime-execution-modes.md +++ b/doc/runtime-execution-modes.md @@ -1,6 +1,7 @@ --- uid: Uno.Wasm.Bootstrap.Runtime.Execution --- + # Runtime Execution Modes The mono for WebAssembly runtime provides three execution modes, Interpreter, AOT (Ahead of Time), and Mixed Mode Interpreter/AOT. diff --git a/doc/troubleshooting.md b/doc/troubleshooting.md index dbe4cd0d1..6859f0b1f 100644 --- a/doc/troubleshooting.md +++ b/doc/troubleshooting.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Features.Troubleshooting +--- + ### Windows Long Path support The bootstrapper supports Windows 10 long paths by default, but there may be cases where the `\\?\` [path format](https://web.archive.org/web/20160818035729/https://blogs.msdn.microsoft.com/jeremykuhne/2016/06/21/more-on-new-net-path-handling/) may not be supported. diff --git a/doc/using-the-bootstrapper.md b/doc/using-the-bootstrapper.md index f44517a8d..f06fb3f51 100644 --- a/doc/using-the-bootstrapper.md +++ b/doc/using-the-bootstrapper.md @@ -1,3 +1,7 @@ +--- +uid: UnoWasmBootstrap.Overview +--- + Uno.Wasm.Bootstrap provides a simple way to package C# .NET code, and run it from a compatible browser environment. It is a standalone .NET Web Assembly (Wasm) sdk bootstrapper taking the form of a nuget package.