Convert docs to VDocFx

docs/articles/FAQ.md

@@ -1,6 +1,6 @@
 # FAQ
 
-Here are some common questions we get. As time goes on, and we get asked more common question, we will add them here.
+Here are some common questions we get. As time goes on, and as we get asked more common question, we will add them here.
 
 ---
 
@@ -19,3 +19,9 @@ Here are some common questions we get. As time goes on, and we get asked more co
 **Q**: Does UWB support proprietary codecs?
 
 **A**: The build of CEF that UWB uses DOES NOT come with proprietary codecs by default. You can however build CEF yourself with proprietary codecs included. Also have fun doing that. (Support will not be given to those who use a custom build of CEF!)
+
+---
+
+**Q**: Does UWB support mobile?
+
+**A**: Short answer, no, and it never will. If you want the long answer, see [#131](https://github.com/Voltstro-Studios/UnityWebBrowser/discussions/131#discussioncomment-4092953).

docs/articles/dev/Setup.md

@@ -34,7 +34,7 @@ To get the [`UnityWebBrowser`](https://github.com/Voltstro-Studios/UnityWebBrows
 git clone --recursive https://github.com/Voltstro-Studios/UnityWebBrowser.git
 ```
 
-> [!NOTE]
+> [!INFO]
 > If you did NOT clone the repo recursively, you can just init the submodules by running these commands at the root of the repo:
 > 
 > ```shell
@@ -66,7 +66,7 @@ Once in Unity, you can open the provided `UWB` scene provided in the project. By
 
 When running the project in this scene, a provided 'UWB Debug UI' will be available.
 
-> [!NOTE]
+> [!INFO]
 > By default this is "hidden", you can open the UI via the small panel at the top of the player's window.
 > ![Panel](~/assets/images/articles/dev/setup/panel.webp)
 
@@ -80,7 +80,7 @@ If you need to, extra controls can be added by modifying the `Assets/Scripts/UWB
 
 ## Dev Scripts
 
-There a many dev scripts in the `src/DevScripts` directory. The main ones that you will most likely use are:
+There are many dev scripts in the `src/DevScripts` directory. The main ones that you will most likely use are:
 
 - `download-cef-<OS>.ps1`
 - `publish-<Section>-<OS>.ps1`

docs/Articles.md → docs/articles/index.md

@@ -1,21 +1,32 @@
 # Unity Web Browser Docs
 
+[![License](https://img.shields.io/github/license/Voltstro-Studios/UnityWebBrowser)](https://github.com/Voltstro-Studios/UnityWebBrowser/blob/master/LICENSE.md)
+[![Discord](https://img.shields.io/badge/Discord-Voltstro-7289da.svg?logo=discord)](https://discord.voltstro.dev)
+
 Welcome to the Unity Web Browser (UWB) documentation site!
 
-UWB is a package that allows displaying and interacting with the web from within Unity. These docs should hopefully get you up and going with UWB.
+These docs should hopefully get you up and going with UWB.
+
+## What is Unity Web Browser (UWB)?
+
+UWB is a package that allows displaying and interacting with the web from within Unity.
 
 ## Docs Guide
 
 The docs are divided into two sections.
 
-- [User](articles/user/Setup.md) - Docs containing information on **using** UWB.
-- [Developers](articles/dev/Dev-Guide.md) - Docs containing information on **developing/contributing to** UWB.
+- [User](user/Setup.md) - Docs containing information on **using** UWB.
+- [Developers](dev/Dev-Guide.md) - Docs containing information on **developing/contributing to** UWB.
 
-If you are just starting, then checkout the [setup section](articles/user/Setup.md).
+If you are just starting, then checkout the [setup section](user/Setup.md).
 
 ## Support
 
-If you need support, PLEASE CHECK both [GitHub issues](https://github.com/Voltstro-Studios/UnityWebBrowser/issues) and [discussions](https://github.com/Voltstro-Studios/UnityWebBrowser/discussions), to see if someone else has already asked your question, or already had your issue, AND check the [FAQ](articles/FAQ.md)!
+If you need support, PLEASE CHECK both [GitHub issues](https://github.com/Voltstro-Studios/UnityWebBrowser/issues) and [discussions](https://github.com/Voltstro-Studios/UnityWebBrowser/discussions), to see if someone else has already asked your question, or already had your issue.
+
+If you cannot find an issue or discussion matching or similar to your problem, then please open a new issue or discussion on GitHub.
+
+We also an [FAQ](FAQ.md), that might answer some basic questions that you might have.
 
 ### Issues
 
@@ -36,3 +47,7 @@ Here are our socials, please don't use these for support!
 [![Twitter Follow](https://img.shields.io/twitter/follow/Voltstro?style=social)](https://twitter.com/Voltstro)
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/VoltstroStudios?style=social)](https://twitter.com/VoltstroStudios)
+
+## Legal
+
+These materials are not sponsored by or affiliated with Unity Technologies or its affiliates. “Unity” is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.

docs/articles/toc.yml

@@ -0,0 +1,27 @@
+items:
+- name: FAQ
+  href: FAQ.md
+
+- name: User
+  items:
+    - name: Setup
+      href: user/Setup.md
+    - name: Usage
+      href: user/Usage.md
+    - name: Packages
+      href: user/Packages.md
+    - name: Engines
+      href: user/Engines.md
+    - name: Logging
+      href: user/Logging.md
+
+- name: Developer
+  items:
+    - name: Developer Guide
+      href: dev/Dev-Guide.md
+    - name: Setup
+      href: dev/Setup.md
+    - name: How Things Work
+      href: dev/How-Things-Work.md
+    - name: Project Layout
+      href: dev/Project-Layout.md

docs/articles/user/Logging.md

@@ -19,7 +19,7 @@ You can change the log severity of the web engine's logging in the editor, or by
 
 ![Log Severity](~/assets/images/articles/user/logging/LogSeverity.webp)
 
-> [!NOTE]
+> [!INFO]
 > Depending on the web engine, in debug mode there can be quite a lot of log messages!
 
 What level the Core's logger does depends on the <xref:VoltstroStudios.UnityWebBrowser.Logging.IWebBrowserLogger> implementation. As the default <xref:VoltstroStudios.UnityWebBrowser.Logging.DefaultUnityWebBrowserLogger> logs straight to Unity's default logger, it will depend on how you have configured Unity's default logger.

docs/articles/user/Setup.md

@@ -1,6 +1,6 @@
 # Setup 
 
-We first need to setup your project for UWB.
+Lets get started with UWB. We first need to setup your Unity project for UWB.
 
 ## Prerequisites
 
@@ -12,36 +12,40 @@ Newer Unity versions should work, but are untested!
 
 ## Registry Setup
 
-To install UWB, the Voltstro UPM registry needs to be added to your project.
+UWB packages are hosted on our UPM registry. As such, the Voltstro UPM registry needs to be added to your project.
 
 To setup the registry with your project, [see here](https://github.com/Voltstro/VoltstroUPM#setup). The Voltstro UPM page also lists some other info that you may be interested in.
 
 **HOWEVER**, an additional scope needs to be added. You need to make sure `com.cysharp.unitask` is added (more details are provided in the [UniTask part](#unitask)). Once you are done configuring your projects registries, your configuration should look like:
 
 ![Registry](~/assets/images/articles/user/setup/Registry.webp)
 
-> [!NOTE]
-> If are using [UnityNuGet](https://github.com/xoofx/UnityNuGet), and you choose not to use the Voltstro UPM as a `org.nuget.*` scope mirror, then don't have the `org.nuget` scope defined for the Voltstro UPM.
+> [!INFO]
+> If you are using [UnityNuGet](https://github.com/xoofx/UnityNuGet), and you choose not to use Voltstro UPM as a UnityNuGet mirror, then don't add the `org.nuget` scope to the Voltstro UPM registry entry.
 
 ### UniTask
 
-> [!NOTE]
-> You are not already using UniTask, you can [skip this part](#installation).
+> [!INFO]
+> If you are not already using UniTask, you can [skip this part](#installation).
 
 The reason why we need to add the additional `com.cysharp.unitask` scope to VoltstroUPM is because UWB depends on [UniTask](https://github.com/Cysharp/UniTask). VoltstroUPM does provide a mirror copy (from OpenUPM) of UniTask,
 however you may already have UniTask installed via [OpenUPM](https://openupm.com/packages/com.cysharp.unitask/), or via [Git](https://github.com/Cysharp/UniTask#install-via-git-url). If you do have it installed already,
-and you don't want to use VoltstroUPM's mirror of it, then DO NOT define the additional scope as apart of VoltstroUPM.
+and you don't want to use Voltstro UPM's mirror of it, then DO NOT define the additional scope as apart of VoltstroUPM.
 
 > [!WARNING]
 > If you already have UniTask installed via Git, please make sure it is the latest version!
 
 ## Installation
 
-Once you have your registries setup, you can install the packages via UPM GUI.
+Once you have the Voltstro UPM registry setup, you can now install the packages via the UPM GUI.
 
 ![Packages](~/assets/images/articles/user/setup/Packages.webp)
 
-You will need the core "Unity Web Browser" package (`dev.voltstro.unitywebbrowser`). An engine package (and it's engine native package) is also required. For more details on what engines are available and their packages, see the [engines section](Engines.md).
+### Packages
+
+UWB is split into multiple packages. The packages that you need will depend on your use case.
+
+You will need the core "Unity Web Browser" package (`dev.voltstro.unitywebbrowser`). An "engine" package (and it's "engine native" package) is also required. For more details on what engines are available and their packages, see the [engines section](Engines.md).
 
 For more information on the different packages, see the [packages section](Packages.md).
 

docs/articles/user/Usage.md

@@ -2,9 +2,11 @@
 
 Alright, lets get to actually using UWB.
 
+tl;dr: Import the [sample](#samples).
+
 ## Platform Support
 
-UWB aims to support all desktop platforms (Windows, Linux, MacOS). The core currently does support all desktop platforms, however you will have to factor in what engine you want to use. Each engine has their own different platform support. See the [engine page](Engines.md) for each engine's platform support.
+UWB aims to support all desktop platforms (Windows, Linux, MacOS). The core package currently does support all desktop platforms, however you will have to factor in what engine you want to use. Each engine has its own different platform support. See the [engine page](Engines.md) for each engine's platform support.
 
 > [!WARNING]
 > UWB does **NOT** support [IL2CPP](https://docs.unity3d.com/Manual/IL2CPP.html)!

docs/menu.yml

@@ -1,8 +1,10 @@
 #YamlMime:Menu
 items:
 - name: Articles
-  href: Articles.md
-- name: API Reference
-  href: api/Index.md
+  href: articles/index.md
+
+- name: API Documentation
+  href: api/index.md
+
 - name: Changelog
   href: changelog/

docs/vdocfx.yml

@@ -0,0 +1,26 @@
+templates:
+  - default
+defaultLocale: en-AU
+hostName: projects.voltstro.dev
+basePath: UnityWebBrowser
+globalMetadata:
+  _appTitle: Unity Web Browser
+  _appFooter: Copyright (c) 2021-2023 Voltstro-Studios
+  _appFooterIcon: assets/images/vs-icon.png
+  menu_path: /UnityWebBrowser/menu.json
+dotnet:
+  assemblies:
+    - '../src/VoltstroStudios.UnityWebBrowser.DocsPrj/UnityWebBrowser.DocsPrj/bin/Debug/netstandard2.1/VoltstroStudios.UnityWebBrowser.Shared.dll'
+    - '../src/VoltstroStudios.UnityWebBrowser.DocsPrj/UnityWebBrowser.DocsPrj/bin/Debug/netstandard2.1/VoltstroStudios.UnityWebBrowser.dll'
+files:
+  - '**'
+  - '../CHANGELOG.md'
+exclude:
+  - 'README.md'
+  - '.gitignore'
+  - 'obj/**/*'
+  - '_site/**/*'
+xref:
+  - https://docs.microsoft.com/en-us/dotnet/.xrefmap.json
+  - https://voltstro-studios.gitlab.io/UnityDocs/UnityXrefMaps/2021.3/xrefmap.yml
+  - https://voltstro-studios.gitlab.io/UnityDocs/UnityXrefMaps/pkgs/[email protected]/xrefmap.yml