Added link from readmes to documentation page

luxonis · Feb 11, 2022 · 82cb3f9 · 82cb3f9
1 parent 5c2cd81
commit 82cb3f9
Show file tree

Hide file tree

Showing 24 changed files with 49 additions and 22 deletions.
diff --git a/BG0249_DepthAI_RGB_Camera/README.md b/BG0249_DepthAI_RGB_Camera/README.md
@@ -1,5 +1,7 @@
 # BG0249_R1M1E1 RGB Camera Module
 
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BG0249.html)
+
 ![](Images/BG0249_R0M0E0_front.png)
 
 # Overview

diff --git a/BG0250TG_DepthAI_Mono_Camera/README.md b/BG0250TG_DepthAI_Mono_Camera/README.md
@@ -1,5 +1,7 @@
 # BG0250TG_R0M0E0 Mono Camera Module
 
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BG0250TG.html)
+
 ![](Images/BG0250TG_R0M0E0_front.png)
 
 # Overview

diff --git a/BW0253_R0M0E0_RPIHQ_ADAPTER/README.md b/BW0253_R0M0E0_RPIHQ_ADAPTER/README.md
@@ -1,4 +1,7 @@
 # BW0253_R0M0E0 Raspberry Pi HQ Cam Adapter Board
+
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW0253.html)
+
 ![](../BW0253_R0M0E0_RPIHQ_ADAPTER/Images/RPI_HQ_CAM_SYSTEM_2020-May-14_08-35-31PM-000_CustomizedView42985702451.png)
 
 # Overview

diff --git a/BW1092_ESP32_Embedded_WIFI_BT/README.md b/BW1092_ESP32_Embedded_WIFI_BT/README.md
@@ -1,5 +1,6 @@
-# BW1092: Embedded DepthAI Reference Design with Onboard ESP32 for WiFi and BT
+# BW1092: OAK-D-IoT-40
 
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/DM1092.html)
 
 # Overview:
 

diff --git a/BW1094_DepthAI_HAT/README.md b/BW1094_DepthAI_HAT/README.md
@@ -1,5 +1,7 @@
 # BW1094_R1M1E1 RPi HAT Baseboard
 
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW1094.html)
+
 ![](Images/BW1094_R0M0E0_front.png)
 
 # Overview

diff --git a/BW1097_DepthAI_Compute_Module/README.md b/BW1097_DepthAI_Compute_Module/README.md
@@ -1,5 +1,7 @@
 # BW1097_R2M2E3 DepthAI for CM3+
 
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW1097.html)
+
 ![](../BW1097_DepthAI_Compute_Module/Images/BW1097_R1M1E2_transparent_crop.png)
 
 # Overview

diff --git a/BW1098FFC_DepthAI_USB3/README.md b/BW1098FFC_DepthAI_USB3/README.md
@@ -1,4 +1,6 @@
-# BW1098FFC DepthAI USB3 Edition (EOL)
+# BW1098FFC: OAK-FFC-3P-OG (EOL)
+
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW1098FFC.html)
 
 BW1098FFC + [BW0250TG](https://github.com/luxonis/depthai-hardware/tree/master/BG0250TG_DepthAI_Mono_Camera) + [BG0249](https://github.com/luxonis/depthai-hardware/tree/master/BG0249_DepthAI_RGB_Camera) are shown together below:
 ![](https://i.imgur.com/LXjLpzX.jpg)

diff --git a/BW1098OAK_USB3C/README.md b/BW1098OAK_USB3C/README.md
@@ -1,4 +1,4 @@
-# OAK-D
+# BW1098: OAK-D
 
 [Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW1098OAK.html)
 

diff --git a/BW2098POE_PoE_Board/README.md b/BW2098POE_PoE_Board/README.md
@@ -1,7 +1,8 @@
 # BW2098POE PoE Board
 
-![image](https://user-images.githubusercontent.com/32992551/92193781-604c4300-ee26-11ea-994e-14f5983bfefa.png)
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW2098POE.html)
 
+![image](https://user-images.githubusercontent.com/32992551/92193781-604c4300-ee26-11ea-994e-14f5983bfefa.png)
 
 # Overview
 

diff --git a/DM0255_DepthAI_pTOF_Camera/README.md b/DM0255_DepthAI_pTOF_Camera/README.md
@@ -1,5 +1,7 @@
 # DM0255 OAK-FFC-pToF
 
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/DM0255.html)
+
 ![DM0255](Images/DM0255_front.png)
 
 # Project Stage

diff --git a/DM1090FFC_DepthAI_USB3/README.md b/DM1090FFC_DepthAI_USB3/README.md
@@ -1,4 +1,6 @@
-# DM1090FFC_R0M0E0 DepthAI USB3 Edition
+# DM1090FFC: OAK-FFC-3P
+
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/DM1090.html)
 
 DM1090FFC + [DM0250TG](https://github.com/luxonis/depthai-hardware/tree/master/DM0250TG_DepthAI_Mono_Camera) + [DM0249](https://github.com/luxonis/depthai-hardware/tree/master/DM0249_DepthAI_RGB_Camera) with compatible Arducam modules are shown together below:
 

diff --git a/DM1092_ESP32_Embedded_WIFI_BT_IMU/README.md b/DM1092_ESP32_Embedded_WIFI_BT_IMU/README.md
@@ -1,11 +1,8 @@
-# DM1092: Embedded DepthAI Reference Design with Onboard ESP32 for WiFi and BT 
+# DM1092: OAK-D IoT 40
 
 ![](Images/FULL-ASM_DM1092_R1M1E1.jpg)
 
-
 # Project Stage
-**Caution: This project is still under development. We are currently in process of getting our board prototyped and tested.** 
-           **We are proactively making our design available for our uses to plan and provide us with design feedback.** 
 
 With this revision the IMU issue is fixed, now connected over SPI. 
 

diff --git a/DM1095_OAK-D-LITE-DEV_DepthAI_USB3C/README.md b/DM1095_OAK-D-LITE-DEV_DepthAI_USB3C/README.md
@@ -2,8 +2,6 @@
 
 ![](Images/OAK-D-LITE-DEV_cover.jpg)
 
-
-
 # Project Stage
 
 This design is now vetted and documents revision updated with corrections. 

diff --git a/DM1097_DepthAI_Compute_Module_4/README.md b/DM1097_DepthAI_Compute_Module_4/README.md
@@ -1,4 +1,4 @@
-# DM1097_R0M0E0 DepthAI for Compute module 4
+# DM1097: OAK-D-CM4
 
 ![image](https://user-images.githubusercontent.com/32992551/109263101-edfa6100-77bf-11eb-85ef-037fe24e9975.png)
 ![image](https://user-images.githubusercontent.com/32992551/112017081-e5f9bc80-8af2-11eb-90ef-16f673ed294c.png)
@@ -7,17 +7,17 @@
 This design is now vetted and currently for sale ([here](https://shop.luxonis.com/collections/all/products/depthai-rpi-compute-module-4-edition)).
 
 # Overview
-This repository contains open hardware designed by Luxonis, and meant to be used as a baseboard for the [Luxonis](https://www.luxonis.com/depthai) [OAK-SOM](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW1099.html) and the [Raspberry Pi Compute Module 4](https://www.raspberrypi.org/products/compute-module-4/?variant=raspberry-pi-cm4001000). 
+This repository contains open hardware designed by Luxonis, and meant to be used as a baseboard for the [Luxonis](https://www.luxonis.com/depthai) [OAK-SOM](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW1099.html) and the [Raspberry Pi Compute Module 4](https://www.raspberrypi.org/products/compute-module-4/?variant=raspberry-pi-cm4001000).
 
-Based on the BW1097 and Raspberry PI CM4IO board, the DM1097 combines a host and the Luxonis DepthAI SoM to allow for a fully integrated solution for real-time spatial AI. 
+Based on the BW1097 and Raspberry PI CM4IO board, the DM1097 combines a host and the Luxonis DepthAI SoM to allow for a fully integrated solution for real-time spatial AI.
 The biggest difference in DM1097 and BW1097 architecture is that DM1097 integrates CM4 module, has gigabit ethernet, and populated with MagJack supporting POE. POE can be used with additional POE Hat.
 
 # Repository structure:
 * `PCB` contains the packaged Altium project files
 * `Docs` contains project output files
 * `Images` contains graphics for readme and reference
 * `3D Models` contains generated 3D models of the board
-* `Mechanical` contains models of mounts, enclosures, and other mechanical parts 
+* `Mechanical` contains models of mounts, enclosures, and other mechanical parts
 
 # Key features
 * Support for onboard stereo and RGB camera modules

diff --git a/DM1098OBC_DepthAI_USB3C_WIFI/README.md b/DM1098OBC_DepthAI_USB3C_WIFI/README.md
@@ -1,5 +1,7 @@
 # OAK-D-IoT-75 | DM1098OBC_WiFi DepthAI USB3C Baseboard
 
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/DM1098OBC.html)
+
 ![image](https://user-images.githubusercontent.com/32992551/110514833-f0649100-80c4-11eb-8e2c-6c164f2d9f48.png)
 ![image](https://user-images.githubusercontent.com/32992551/110514872-fce8e980-80c4-11eb-95f7-552f1ff6fdf7.png)
 

diff --git a/DM2097_OAK-D-CM4-POE/README.md b/DM2097_OAK-D-CM4-POE/README.md
@@ -1,5 +1,7 @@
 # OAK-D-CM4-POE DepthAI for Compute module 4
 
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/DM2097.html)
+
 ![image](https://user-images.githubusercontent.com/32992551/136113702-559d0aa4-a39c-41e7-86e7-905b373d8323.png)
 ![image](https://user-images.githubusercontent.com/32992551/135191716-e1d49fb1-23c2-4d9d-b4d4-d0f440e31a3f.png)
 ![](Images/DM2097_R0M0E0_FRONT.png)

diff --git a/DM6010_Y-adapter/README.md b/DM6010_Y-adapter/README.md
@@ -1,5 +1,6 @@
 # Y-adapter
 
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/DM6010.html)
 
 ![](https://docs.luxonis.com/projects/hardware/en/latest/_images/Y-adapter_front.png)
 

diff --git a/NG2094_OAK-D-PRO-W-DEV/README.md b/NG2094_OAK-D-PRO-W-DEV/README.md
@@ -2,8 +2,6 @@
 
 ![](Images/OAK-D-PRO-W-DEV-full-build.png)
 
-
-
 # Project Stage
 
 This design is still in the development phase. Some errors might be present in the design or documentation. 

diff --git a/SJ2088POE_PoE_Board/README.md b/SJ2088POE_PoE_Board/README.md
@@ -1,5 +1,7 @@
 # SJ2088POE OAK-D-POE with IP67 Enclosure
 
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/SJ2088POE.html)
+
 ![IMG_3045](https://user-images.githubusercontent.com/32992551/109262631-1cc40780-77bf-11eb-9263-034dd1b55ad4.JPG)
 (Enclosure STEP file is [here](https://drive.google.com/file/d/18MleH4f2TQZvNOU39eg31wnYMboooq5U/view))
 

diff --git a/SJ2096POE_R0M0E0/README.md b/SJ2096POE_R0M0E0/README.md
@@ -1,4 +1,6 @@
-# SJ2096POE LDC-1-POE Board in IP67 Enclosure
+# SJ2096POE: OAK-1-PoE
+
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/SJ2096POE.html)
 
 ![IMG_3041](https://user-images.githubusercontent.com/32992551/109261978-fce01400-77bd-11eb-8895-2a5083a61013.JPG)
 ![image](https://user-images.githubusercontent.com/32992551/109262197-58aa9d00-77be-11eb-9d58-88723eb1eef3.png)

diff --git a/SoMs/OAK-SoM-IoT/README.md b/SoMs/OAK-SoM-IoT/README.md
@@ -1,4 +1,6 @@
-OAK-SoM-IoT SoM
+# OAK-SoM-IoT
+
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW1099EMB.html)
 
 CONTENTS:
 

diff --git a/SoMs/OAK-SoM-Pro/README.md b/SoMs/OAK-SoM-Pro/README.md
@@ -1,4 +1,6 @@
-OAK-SoM-Pro
+# OAK-SoM-Pro
+
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW2099.html)
 
 CONTENTS:
 

diff --git a/SoMs/OAK-SoM/README.md b/SoMs/OAK-SoM/README.md
@@ -1,4 +1,6 @@
-OAK-SoM
+# OAK-SoM
+
+[Documentation here](https://docs.luxonis.com/projects/hardware/en/latest/pages/BW1099.html)
 
 CONTENTS:
 

diff --git a/SoMs/README.md b/SoMs/README.md
@@ -1,2 +1,2 @@
-Each folder is dedicated to a particular SoM variant and contains datasheets, symbols, footprints, pinouts and other information about the Luxonis systems-on-module (SoMs). 
+Each folder is dedicated to a particular SoM variant and contains datasheets, symbols, footprints, pinouts and other information about the Luxonis systems-on-module (SoMs).