From ceff8d215eb137bb015795a6db1393871fc2dc96 Mon Sep 17 00:00:00 2001 From: Jason Kridner <jkridner@beagleboard.org> Date: Tue, 14 May 2024 08:36:45 -0400 Subject: [PATCH] Confusion about where to put add-on usage docs The "expansion" section is meant to be about how to *build* expansion hardware. This is where we provide information about what we expect people to do when building add-on hardware, not about telling people how to use it. They can infer how to use it, but that should really be broken down into the "quick start", "design" and "demos" sections. --- boards/beagley/ai/04-expansion.rst | 12 ++++++++---- boards/beagley/ai/05-demos.rst | 1 + .../connecting-imx219-csi-cameras.rst} | 0 3 files changed, 9 insertions(+), 4 deletions(-) rename boards/beagley/ai/{expansion/Connecting IMX219 CSI Cameras.rst => demos/connecting-imx219-csi-cameras.rst} (100%) diff --git a/boards/beagley/ai/04-expansion.rst b/boards/beagley/ai/04-expansion.rst index 2421718d..581ef009 100644 --- a/boards/beagley/ai/04-expansion.rst +++ b/boards/beagley/ai/04-expansion.rst @@ -5,12 +5,16 @@ Expansion .. todo:: - Describe how to build expansion hardware for BeagleY-AI + Describe how to build expansion hardware for BeagleY-AI. This section is not about using existing add-on hardware. PCIe **** -For software reference, you can see how PCIe is used on NVMe HATs. +For software reference, you can :ref:`see how PCIe is used on NVMe HATs<beagley-ai-expansion-nvme>`. -* :ref:`beagley-ai-expansion-nvme` -* :ref:`beagley-ai-imx219-csi-cameras` + + +CSI +*** + +For software reference, you can :ref:`see how CSI is used on IMX219-based camera modules<beagley-ai-imx219-csi-cameras>`. diff --git a/boards/beagley/ai/05-demos.rst b/boards/beagley/ai/05-demos.rst index aff8255f..f928b204 100644 --- a/boards/beagley/ai/05-demos.rst +++ b/boards/beagley/ai/05-demos.rst @@ -9,4 +9,5 @@ Demos and tutorials demos/beagley-ai-expansion-nvme demos/beagley-ai-pca9685-motor-drivers demos/beagley-ai-arducam-imx219-v3link-dual-camera-kit + demos/connecting-imx219-csi-cameras diff --git a/boards/beagley/ai/expansion/Connecting IMX219 CSI Cameras.rst b/boards/beagley/ai/demos/connecting-imx219-csi-cameras.rst similarity index 100% rename from boards/beagley/ai/expansion/Connecting IMX219 CSI Cameras.rst rename to boards/beagley/ai/demos/connecting-imx219-csi-cameras.rst -- GitLab