diff --git a/doc/developer-guides/ACPI-virt-hld.rst b/doc/developer-guides/ACPI-virt-hld.rst index e36ca7237..c34faa2f0 100644 --- a/doc/developer-guides/ACPI-virt-hld.rst +++ b/doc/developer-guides/ACPI-virt-hld.rst @@ -1,6 +1,6 @@ .. _ACPI-virt-HLD: -ACPI Virtualization High Level Design +ACPI Virtualization high-level design ##################################### ACPI introduction diff --git a/doc/developer-guides/APL_GVT-g-hld.rst b/doc/developer-guides/APL_GVT-g-hld.rst index 413a55551..16112ec7b 100644 --- a/doc/developer-guides/APL_GVT-g-hld.rst +++ b/doc/developer-guides/APL_GVT-g-hld.rst @@ -1,7 +1,7 @@ .. _APL_GVT-G-hld: -Apollo Lake IntelĀ® GVT-G high-level design -########################################## +GVT-G high-level design +####################### Introduction ************ diff --git a/doc/developer-guides/index.rst b/doc/developer-guides/index.rst index f6ec9c2b7..5ce2f4a34 100644 --- a/doc/developer-guides/index.rst +++ b/doc/developer-guides/index.rst @@ -7,14 +7,22 @@ Developer Guides :maxdepth: 1 primer.rst + ../api/index.rst + ../reference/kconfig/index.rst + +High-Level Design Guides +************************ + +These documents describe the high-level design, background, and motivation for +specific areas within the ACRN hypervisor system. + +.. toctree:: + :maxdepth: 1 + memmgt-hld.rst virtio-hld.rst ACPI-virt-hld.rst APL_GVT-g-hld.rst - ../api/index.rst - ../reference/kconfig/index.rst - trusty.rst - Contributing to the project *************************** diff --git a/doc/developer-guides/memmgt-hld.rst b/doc/developer-guides/memmgt-hld.rst index 8f230c18a..bfad3ea7b 100644 --- a/doc/developer-guides/memmgt-hld.rst +++ b/doc/developer-guides/memmgt-hld.rst @@ -1,6 +1,6 @@ .. _memmgt-hld: -Memory Management High-Level Design +Memory Management high-level design ################################### This document describes memory management for the ACRN hypervisor. diff --git a/doc/developer-guides/trusty.rst b/doc/developer-guides/trusty.rst index 7e5daf146..44a0d4696 100644 --- a/doc/developer-guides/trusty.rst +++ b/doc/developer-guides/trusty.rst @@ -1,3 +1,5 @@ +:orphan: + .. _trusty_tee: Trusty TEE on ACRN diff --git a/doc/developer-guides/virtio-hld.rst b/doc/developer-guides/virtio-hld.rst index 41022f8f2..5899b1c8f 100644 --- a/doc/developer-guides/virtio-hld.rst +++ b/doc/developer-guides/virtio-hld.rst @@ -1,6 +1,6 @@ .. _virtio-hld: -Virtio High Level Design +Virtio high-level design ######################## The ACRN Hypervisor follows the `Virtual I/O Device (virtio) diff --git a/doc/getting-started/index.rst b/doc/getting-started/index.rst index 2c8fc9da3..41207f479 100644 --- a/doc/getting-started/index.rst +++ b/doc/getting-started/index.rst @@ -17,6 +17,5 @@ described in :ref:`hardware`. Follow the setup guides listed here: .. toctree:: :maxdepth: 1 - hardware.rst apl-nuc.rst up2.rst diff --git a/doc/getting-started/hardware.rst b/doc/hardware.rst similarity index 100% rename from doc/getting-started/hardware.rst rename to doc/hardware.rst diff --git a/doc/index.rst b/doc/index.rst index 3eb8c9b44..577001774 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -26,6 +26,7 @@ Sections introduction/index.rst getting-started/index.rst + hardware.rst user-guides/index.rst developer-guides/index.rst tutorials/index.rst