Skip to content

Commit ce4addc

Browse files
jonathanpeppersjonathanpeppers
authored
[docs] Sync Documentation/docs-mobile with dotnet/docs-mobile (#10907)
Fixes: #10902 Sync local documentation with the upstream dotnet/docs-mobile repo: - Restore f1_keywords metadata and blank-line style to match docs-mobile - Use docs-mobile as source of truth for dependencies.md, with JDK 21 fix - Add f1_keywords to local-only message files (APT2000, XA1040, XA1041) - Add missing TOC.yml entries for APT2000, XA1039, XA1040, XA1041 * [docs] Fix typos in message documentation - xa0004: 'is and integer' → 'is an integer' - xa0132: 'you device' → 'your device' - xa0133: 'the the' → 'the' - xa8000: 'Nuget' → 'NuGet', '.net 8' → '.NET 8' * [docs] Fix dependencies.md JDK section structure Move JDK installation steps 2-3 into the 'Install Microsoft JDK manually' section so the numbered list is contiguous. Indent the ANDROID_HOME code block under list item 7 so it renders correctly.
1 parent f708e85 commit ce4addc

File tree

146 files changed

+514
-67
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+514
-67
lines changed

‎.github/copilot-instructions.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
## Critical Rules
2121

22+
**Never use `git commit --amend`:** Always create new commits. The user will squash or fixup as needed.
23+
2224
Reference official Android documentation where helpful:
2325
* [Android Developer Guide](https://developer.android.com/develop)
2426
* [Android API Reference](https://developer.android.com/reference)

‎Documentation/docs-mobile/getting-started/installation/dependencies.md‎

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,23 @@ Here are all the arguments which the target will use when installing the depende
4444
> [!NOTE]
4545
> To make development easier try to avoid using paths which contain spaces or non-ASCII characters.
4646
47+
## Install Microsoft JDK manually
48+
49+
In order to build .NET for Android applications or libraries you need to have a version of the Java Development Kit installed.
50+
We recommend you use the Microsoft Open JDK, this has been tested against our .NET for Android builds:
51+
52+
1. Download [Microsoft OpenJDK 21](/java/openjdk/download#openjdk-21).
53+
54+
2. Depending on your platform run the appropriate installer.
55+
56+
3. It is also good practice to set the `JAVA_HOME` environment variable.
57+
This will allow you to use the JDK from the Command Prompt or Terminal.
58+
4759
## Install the Android SDK manually
4860

61+
> [!NOTE]
62+
> On Windows you will need to install JDK first.
63+
4964
You might find it necessary to install the Android SDK manually:
5065

5166
1. Go to [Android Studio download](https://developer.android.com/studio#download).
@@ -61,6 +76,12 @@ You might find it necessary to install the Android SDK manually:
6176
5. Navigate to the `android-sdk\cmdline-tools\bin` directory within the directory you created.
6277

6378
6. Run the `sdkmanager` command to install the desired components.
79+
80+
7. Set the `$ANDROID_HOME` environment variable to your Android SDK path:
81+
82+
```powershell
83+
$env:ANDROID_HOME = "C:\android-sdk"
84+
```
6485
6586
For example, to install the latest platform and platform tools, use:
6687
@@ -92,15 +113,3 @@ The following component types are useful to know:
92113

93114
It is also good practice to set the `ANDROID_HOME` environment variable, as this
94115
allows you to use certain tooling from the command line.
95-
96-
## Install Microsoft JDK manually
97-
98-
In order to build .NET for Android applications or libraries you need to have a version of the Java Development Kit installed.
99-
We recommend you use the Microsoft Open JDK, this has been tested against our .NET for Android builds:
100-
101-
1. Download [Microsoft OpenJDK 21](/java/openjdk/download#openjdk-21).
102-
103-
2. Depending on your platform run the appropriate installer.
104-
105-
3. It is also good practice to set the `JAVA_HOME` environment variable.
106-
This will allow you to use the JDK from the Command Prompt or Terminal.

‎Documentation/docs-mobile/messages/adb0000.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
title: .NET for Android error/warning ADB0000
33
description: ADB0000 error/warning code
44
ms.date: 04/11/2024
5+
f1_keywords:
6+
- "ADB0000"
57
---
8+
69
# .NET for Android error/warning ADB0000
710

811
## Example messages

‎Documentation/docs-mobile/messages/adb0010.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
title: .NET for Android error/warning ADB0010
33
description: ADB0010 error/warning code
44
ms.date: 04/11/2024
5+
f1_keywords:
6+
- "ADB0010"
57
---
8+
69
# .NET for Android error/warning ADB0010
710

811
## Issue

‎Documentation/docs-mobile/messages/adb0020.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
title: .NET for Android error ADB0020
33
description: ADB0020 error code
44
ms.date: 04/11/2024
5+
f1_keywords:
6+
- "ADB0020"
57
---
8+
69
# .NET for Android error ADB0020
710

811
## Example messages

‎Documentation/docs-mobile/messages/adb0030.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
title: .NET for Android error ADB0030
33
description: ADB0030 error code
44
ms.date: 04/11/2024
5+
f1_keywords:
6+
- "ADB0030"
57
---
8+
69
# .NET for Android error ADB0030
710

811
## Example messages

‎Documentation/docs-mobile/messages/adb0040.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
title: .NET for Android error ADB0040
33
description: ADB0040 error code
44
ms.date: 04/11/2024
5+
f1_keywords:
6+
- "ADB0040"
57
---
8+
69
# .NET for Android error ADB0040
710

811
## Example messages

‎Documentation/docs-mobile/messages/adb0050.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
title: .NET for Android error ADB0050
33
description: ADB0050 error code
44
ms.date: 04/11/2024
5+
f1_keywords:
6+
- "ADB0050"
57
---
8+
69
# .NET for Android error ADB0050
710

811
## Example messages

‎Documentation/docs-mobile/messages/adb0060.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
title: .NET for Android error ADB0060
33
description: ADB0060 error code
44
ms.date: 04/11/2024
5+
f1_keywords:
6+
- "ADB0060"
57
---
8+
69
# .NET for Android error ADB0060
710

811
## Example messages

‎Documentation/docs-mobile/messages/andas0000.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
title: .NET for Android error/warning ANDAS0000
33
description: ANDAS0000 error/warning code
44
ms.date: 04/11/2024
5+
f1_keywords:
6+
- "ANDAS0000"
57
---
8+
69
# .NET for Android error/warning ANDAS0000
710

811
## Issue

0 commit comments

Comments
 (0)