source: Refactor general design and overview

Change-Id: Id88b0f6e5ba4a6c1a5f814ef0877dd47b3934db5 Signed-off-by: UtsavBalar1231 <[email protected]>
vicharak-in · Jul 5, 2023 · f1f0697 · f1f0697
1 parent a581962
commit f1f0697
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 67 deletions.
diff --git a/source/Downloads.rst b/source/Downloads.rst
@@ -1,6 +1,6 @@
 .. _Downloads:
 
-Downloads
+Vaaman Downloads
 =========
 
 	Datasheets

diff --git a/source/Overview.rst b/source/Overview.rst
@@ -3,21 +3,6 @@
 Overview
 ========
 
-What is Vaaman
---------------
-
-	.. |text_vaaman| replace:: The Vaaman Single Board Computer (SBC) combines the RK3399 processor and Efinix Trion T120 FPGA. It offers a powerful yet energy-efficient computing solution for various applications. The RK3399 processor provides high performance and low power consumption, while the Trion T120 FPGA allows for customizable hardware acceleration. With its compact size, the Vaaman SBC is suitable for space-constrained environments and offers a range of connectivity options. Overall, it empowers developers to create innovative solutions that require both processing power and hardware customization.
-
-	.. |image_vaaman| image:: images/Vaaman-top.webp
-		:width: 100%
-
-	.. table::
-		:widths: 50 50
-
-		+----------------+---------------+
-		| |image_vaaman| + |text_vaaman| +
-		+----------------+---------------+
-
 Who is Vaaman For?
 ------------------
 
@@ -37,8 +22,8 @@ Features
 
 The Vaaman Single Board Computer (SBC) offers a range of hardware features, including:
 
-.. list-table:: 
-   :widths: 15 10 
+.. list-table::
+   :widths: 15 10
    :header-rows: 1
 
    * - Type
@@ -49,9 +34,9 @@ The Vaaman Single Board Computer (SBC) offers a range of hardware features, incl
    * - Audio
      - 3.5mm jack with mic
    * - Ethernet
-     - 10/100/1000Mbps Ethernet (Realtek RTL8211E)   
+     - 10/100/1000Mbps Ethernet (Realtek RTL8211E)
    * - Camera
-     - MIPI CSI 2 lanes via FPC connector, support up to 800MP camera   
+     - MIPI CSI 2 lanes via FPC connector, support up to 800MP camera
    * - Wireless
      - Integrated WiFi Combo Module (6222B-SRC) WiFi 2.4G+5G WiFi 2T2R BT5.0
    * - PCIe
@@ -61,17 +46,17 @@ The Vaaman Single Board Computer (SBC) offers a range of hardware features, incl
    * - RTC
      - Support RTC, on-board backup battery interface
    * - I/O
-     - | 1 x UART 
-       | 2 x SPI bus 
-       | 2 x I2C bus 
-       | 1 x PCM/I2S 
-       | 1 x SPDIF 
-       | 1 x PWM 
-       | 1 x ADC 
-       | 6 x GPIO 
-       | 2 x 5V DC 
+     - | 1 x UART
+       | 2 x SPI bus
+       | 2 x I2C bus
+       | 1 x PCM/I2S
+       | 1 x SPDIF
+       | 1 x PWM
+       | 1 x ADC
+       | 6 x GPIO
+       | 2 x 5V DC
        | 2 x 3.3V power pin
-   * - FPGA 
+   * - FPGA
      - | Efinix® T120F324 device in a 324-ball FineLine BGA package.
        | DRAM Chip DDR3 SDRAM 4Gbit 256Mx16 1.35V/1.5V.
        | 128 Mbit SPI NOR flash memory.
@@ -85,6 +70,6 @@ The Vaaman Single Board Computer (SBC) offers a range of hardware features, incl
        | 10, 20, 25, 30, 50, and 74.25 MHz oscillators for T120F324 PLL input.
        | 4 User LEDs on T120F324 bank 2F.
 
-* Link to :ref:`getting started <getting-started>`
-* Link to :ref:`vaaman applications <vaaman-applications>`
-* Link to :ref:`Downloads <Downloads>`
+* Check out :ref:`Getting Started with Vicharak Vaaman <getting-started>`
+* Check out :ref:`Vaaman Application Documentation <vaaman-applications>`
+* Check out :ref:`Downloads <Downloads>`
diff --git a/source/_static/custom.css b/source/_static/custom.css
@@ -0,0 +1,3 @@
+pre {
+    padding-left:0px;
+}
diff --git a/source/conf.py b/source/conf.py
@@ -26,7 +26,7 @@
 
 # Templates. Relative to the source directory.
 templates_path = ["_templates"]
-exclude_patterns = []
+exclude_patterns = ["build"]
 
 # Master document.
 master_doc = "index"

diff --git a/source/get-help.rst → source/getting-help.rst b/source/get-help.rst → source/getting-help.rst
diff --git a/source/index.rst b/source/index.rst
@@ -5,18 +5,35 @@
 
 Welcome to Vaaman's documentation!
 ==================================
+The Vaaman Single Board Computer (SBC) combines the RK3399 processor and Efinix Trion T120 FPGA.
+It offers a powerful yet energy-efficient computing solution for various applications.
+
+The RK3399 processor provides high performance and low power consumption, while the Trion T120 FPGA allows for customizable hardware acceleration.
+With its compact size, the Vaaman SBC is suitable for space-constrained environments and offers a range of connectivity options. Overall, it empowers developers to create innovative solutions that require both processing power and hardware customization.
+
+
+.. image:: images/Vaaman-top.webp
+    :width: 50%
+    :align: center
+
 
 .. toctree::
    :maxdepth: 2
+   :caption: Index
+
+   Overview of Vicharak Vaaman <Overview>
+   Getting Started with Vaaman <getting-started>
+   Vaaman SDK Documentation <vaaman-sdk>
+   Vaaman Application Documentation <vaaman-applications>
+   Getting Help <getting-help>
+
+.. toctree:: vaaman-linux/index
+   :maxdepth: 2
+   :caption: Linux Documentation
 
-   Overview
-   getting-started
-   Downloads
-   vaaman-sdk
-   vaaman-applications
-   vaaman-linux/index
-   get-help
-   linux-document
+.. toctree:: Downloads
+   :maxdepth: 1
+   :caption: Downloads
 
 Indices and tables
 ==================

diff --git a/source/linux-document.rst b/source/linux-document.rst
diff --git a/source/vaaman-linux/linux-configuration-guide/index.rst b/source/vaaman-linux/linux-configuration-guide/index.rst
@@ -5,6 +5,6 @@ These guides are written in a way that even a beginner can follow them.
 
 .. toctree::
     :maxdepth: 2
-    :caption: Contents:
+    :caption: Configuration Guides
 
-    vicharak-config-tool
+    Vicharak Linux Configuration Utility <vicharak-config-tool>
diff --git a/source/vaaman-linux/linux-development-guide/index.rst b/source/vaaman-linux/linux-development-guide/index.rst
@@ -6,9 +6,9 @@ This guide is intended for developers who want to develop linux and linux applic
 
 .. toctree::
     :maxdepth: 2
-    :caption: Contents:
+    :caption: Development Guide
 
-    build-u-boot
-    build-linux-kernel
-    build-linux-rootfs
-    build-linux-image
+    How to build u-boot <build-u-boot>
+    How to build linux kernel <build-linux-kernel>
+    How to build linux rootfs image <build-linux-rootfs>
+    How to create a linux system image <build-linux-image>
diff --git a/source/vaaman-linux/linux-usage-guide/index.rst b/source/vaaman-linux/linux-usage-guide/index.rst
@@ -5,6 +5,6 @@ This guide is intended to help you get started with Linux on your Vicharak Board
 
 .. toctree::
     :maxdepth: 2
-    :caption: Contents:
+    :caption: User Guides
 
-    spi-configure
+    How to flash FPGA firmware to SPI Flash <spi-configure>