deprecate "adding new platform"

ricardoquesada · Dec 30, 2023 · b212724 · b212724
1 parent cea5e5b
commit b212724
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/docs/adding_new_custom_platform.md b/docs/adding_new_custom_platform.md
@@ -9,7 +9,7 @@ Adding a new custom platform is easy:
 
 ## 1. Custom platform file
 
-Use the existing platform as an exmaple:
+Use the existing platform as an example:
 
 * [src/main/uni_platform_custom_1.c]
 

diff --git a/docs/adding_new_platform.md b/docs/adding_new_platform.md
@@ -1,5 +1,11 @@
 # Adding a new platform
 
+## DEPRECATED in v4.0
+
+Read [Adding new Custom Platform][adding_new_custom_platform] instead.
+
+[adding_new_custom_platform]: adding_new_custom_platform.md
+
 Adding a new platform is easy:
 
 1. Create your `src/components/bluepad32/uni_platform_yourplatform.c` file
@@ -9,7 +15,7 @@ Adding a new platform is easy:
 
 ## 1. Platform file
 
-Use the existing platform as an exmaple:
+Use the existing platform as an example:
 
 * [uni_platform_nina.c]