Skip to content

Commit b79c8fe

Browse files
committed
Update docs to all use lower-case file names
Update doc xref to use .xrefmap.json
1 parent d712ecb commit b79c8fe

15 files changed

Lines changed: 28 additions & 31 deletions

File tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ This section contains docs useful for developers who want to work on UWB's code.
77
> - Advance Unity Knowledge
88
> - Advance C# & .NET Knowledge
99
10-
To get going, see the [setup section](Setup.md).
10+
To get going, see the [setup section](setup.md).
1111

1212
When developing for UWB, it is highly recommended to develop using `UnityWebBrowser.UnityProject` provided in the repo. Other means of development will **NOT** be supported! Even if you are creating an external separate package for UWB, it is still recommended to develop using the provided project in the repo! We recommend this approach as the Unity project has all dependencies ready to go, all the tools, and proper projects setup for the code (both Engine and Core).
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/articles/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ UWB is a package that allows displaying and interacting with the web from within
88

99
The docs are divided into two sections.
1010

11-
- [User](user/Setup.md) - Docs containing information on **using** UWB.
12-
- [Developers](dev/Dev-Guide.md) - Docs containing information on **developing/contributing to** UWB.
11+
- [User](user/setup.md) - Docs containing information on **using** UWB.
12+
- [Developers](dev/dev-guide.md) - Docs containing information on **developing/contributing to** UWB.
1313

14-
If you are just starting, then checkout the [setup section](user/Setup.md).
14+
If you are just starting, then checkout the [setup section](user/setup.md).
1515

1616
## Support
1717

18-
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](FAQ.md)!
18+
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](faq.md)!
1919

2020
### Issues
2121

docs/articles/toc.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22
href: index.md
33

44
- name: FAQ
5-
href: FAQ.md
5+
href: faq.md
66

77
- name: User
88
items:
99
- name: Setup
10-
href: user/Setup.md
10+
href: user/setup.md
1111
- name: Packages
12-
href: user/Packages.md
12+
href: user/packages.md
1313
- name: Usage
14-
href: user/Usage.md
14+
href: user/usage.md
1515
- name: Engines
16-
href: user/Engines.md
16+
href: user/engines.md
1717
- name: Logging
18-
href: user/Logging.md
18+
href: user/logging.md
1919
- name: JavaScript
2020
href: user/javascript.md
2121
- name: Client Events
@@ -24,10 +24,10 @@
2424
- name: Developer
2525
items:
2626
- name: Developer Guide
27-
href: dev/Dev-Guide.md
27+
href: dev/dev-guide.md
2828
- name: Setup
29-
href: dev/Setup.md
29+
href: dev/setup.md
3030
- name: How Things Work
31-
href: dev/How-Things-Work.md
31+
href: dev/how-things-work.md
3232
- name: Project Layout
33-
href: dev/Project-Layout.md
33+
href: dev/project-layout.md
File renamed without changes.

docs/articles/user/javascript.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ browserClient.ExecuteJs("console.log('Hello World');");
1010

1111
Which will result in the log message being logged out:
1212

13-
![Log](/assets/images/articles/user/javascript/hello-world-log.webp)
13+
![Log](~/assets/images/articles/user/javascript/hello-world-log.webp)
1414

1515
## JS Methods
1616

@@ -78,7 +78,7 @@ There are a few requirements of your target method that you want to call.
7878

7979
By default, JS methods are entirely disabled. You can enable it by setting <xref:VoltstroStudios.UnityWebBrowser.Core.Js.JsMethodManager.jsMethodsEnable> to `true`. You can do this in the Unity editor UI.
8080

81-
![Enable JS Methods](/assets/images/articles/user/javascript/enable-js-methods.webp)
81+
![Enable JS Methods](~/assets/images/articles/user/javascript/enable-js-methods.webp)
8282

8383
### Registering Methods
8484

@@ -133,7 +133,7 @@ public class UWBPrjDemo : MonoBehaviour
133133
}
134134
```
135135

136-
> [!NOTE]
136+
> [!TIP]
137137
> By default, RegisterJsMethod can work up to 6 arguments. If you need more arguments simply just use an object.
138138
>
139139
> If you cannot use an object for some reason, you can use the low-level <xref:VoltstroStudios.UnityWebBrowser.Core.Js.JsMethodManager.RegisterJsMethod(System.String,System.Reflection.MethodInfo,System.Object)> method instead.
@@ -151,4 +151,4 @@ uwb.ExecuteJsMethod('TestObject', {Test: 'Hello World!'});
151151
uwb.ExecuteJsMethod('TestObjectChild', {Test: {Test: 'Hello World!'}, What: 'Voltstro Woz Here'});
152152
```
153153

154-
![Results](/assets/images/articles/user/javascript/executed-results.webp)
154+
![Results](~/assets/images/articles/user/javascript/executed-results.webp)
File renamed without changes.

0 commit comments

Comments
 (0)