Merge pull request greatscottgadgets#160 from straithe/documentation_…

…updates documentation updates
antoinevg · Aug 16, 2024 · b5d5d4d · b5d5d4d
2 parents 0f63526 + 9992ee0
commit b5d5d4d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 16 deletions.
diff --git a/docs/source/introduction.rst → docs/source/hardware/device_overview.rst b/docs/source/introduction.rst → docs/source/hardware/device_overview.rst
@@ -1,21 +1,6 @@
-============
-Introduction
-============
-
-What is Cynthion?
------------------
-
-Cynthion is an all-in-one tool for building, testing, monitoring, and experimenting with USB devices. Built around a unique FPGA-based architecture, Cynthion’s digital hardware can be fully customized to suit the application at hand. As a result, it can act as a no-compromise High-Speed USB protocol analyzer, a USB-hacking multi-tool, or a USB development platform.
-
-Out-of-the-box, Cynthion acts as a USB protocol analyzer capable of capturing and analyzing traffic between a host and any Low-, Full-, or High-Speed ("USB 2.0") USB device. It works seamlessly with our `Packetry <https://github.com/greatscottgadgets/packetry>`__ open-source analysis software.
-
-Combined with our `LUNA <https://luna.readthedocs.io>`__ gateware and `Facedancer <https://facedancer.readthedocs.io>`__ libraries, Cynthion becomes a versatile USB-hacking and development tool. Facedancer makes it quick and easy to create or tamper with real USB devices—not just emulations—even if you don’t have experience with digital hardware design, HDL, or FPGA architecture!
-
-
 Device Overview
 ---------------
 
-
 Top View
 ~~~~~~~~
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,7 +10,7 @@ Cynthion Documentation
   :maxdepth: 2
   :caption: User Documentation
 
-  introduction
+  project description
   getting_started
   getting_started_packetry
   getting_started_facedancer
@@ -22,6 +22,7 @@ Cynthion Documentation
   :caption: Cynthion Hardware
 
   hardware/introduction
+  hardware/device_overview
   hardware/bringup_guide
   hardware/cli
 

diff --git a/docs/source/project_description.rst b/docs/source/project_description.rst
@@ -0,0 +1,9 @@
+============================
+Cynthion Project Description
+============================
+
+Cynthion is an all-in-one tool for building, testing, monitoring, and experimenting with USB devices. Built around a unique FPGA-based architecture, Cynthion’s digital hardware can be fully customized to suit the application at hand. As a result, it can act as a no-compromise High-Speed USB protocol analyzer, a USB-hacking multi-tool, or a USB development platform.
+
+Out-of-the-box, Cynthion acts as a USB protocol analyzer capable of capturing and analyzing traffic between a host and any Low-, Full-, or High-Speed ("USB 2.0") USB device. It works seamlessly with our `Packetry <https://github.com/greatscottgadgets/packetry>`__ open-source analysis software.
+
+Combined with our `LUNA <https://luna.readthedocs.io>`__ gateware and `Facedancer <https://facedancer.readthedocs.io>`__ libraries, Cynthion becomes a versatile USB-hacking and development tool. Facedancer makes it quick and easy to create or tamper with real USB devices—not just emulations—even if you don’t have experience with digital hardware design, HDL, or FPGA architecture!