diff --git a/doc/contribute.rst b/doc/contribute.rst index cf24d3dbb..9c7425efc 100644 --- a/doc/contribute.rst +++ b/doc/contribute.rst @@ -1,7 +1,7 @@ .. _contribute_acrn: -Contribute to ACRN -################## +Developer Reference +################### Here's where you'll find details about ACRN's high-level design and design principles, along with guidelines followed by the @@ -27,8 +27,8 @@ also find details about specific architecture topics. developer-guides/VBSK-analysis -Contributing Guides -******************* +Contribute Guides +***************** As an open-source project, we welcome and encourage the community to submit patches for code, documentation, tests, and more, directly to the @@ -45,15 +45,12 @@ the project. developer-guides/graphviz tutorials/docbuild -.. _tools: - -Tools -***** +API Documentation +***************** .. toctree:: - :glob: :maxdepth: 1 - misc/tools/acrn-crashlog/README - misc/tools/** - misc/acrn-manager/** + api/index + + diff --git a/doc/develop.rst b/doc/develop.rst index 953a2c3b3..921d4c941 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -1,38 +1,41 @@ .. _develop_acrn: -Develop using ACRN -################## +Advanced Guides +############### -Configuration Tools -******************* +Tools +***** + + **Configuration Tools** + + .. toctree:: + :maxdepth: 1 + + tutorials/acrn_configuration_tool + reference/kconfig/index + user-guides/acrn-dm-parameters + + .. _tools: + + **Runtime Tools** + + .. toctree:: + :glob: + :maxdepth: 1 + + misc/tools/acrn-crashlog/README + misc/tools/** + misc/acrn-manager/** + +Service VM Tutorials +******************** .. toctree:: :maxdepth: 1 - tutorials/acrn_configuration_tool - -Configuration Tutorials -*********************** - -.. toctree:: - :maxdepth: 1 - - tutorials/up2 - tutorials/increase-uos-disk-size - tutorials/sign_clear_linux_image - tutorials/static-ip - tutorials/debug - tutorials/using_partition_mode_on_nuc - tutorials/using_partition_mode_on_up2 - tutorials/using_sdc2_mode_on_nuc - tutorials/using_hybrid_mode_on_nuc - tutorials/realtime_performance_tuning - tutorials/kbl-nuc-sdc - tutorials/enable_laag_secure_boot - tutorials/building_acrn_in_docker - tutorials/acrn_ootb - tutorials/run_kata_containers + tutorials/using_ubuntu_as_sos + tutorials/running_deb_as_serv_vm User VM Tutorials ***************** @@ -50,15 +53,6 @@ User VM Tutorials tutorials/running_deb_as_user_vm tutorials/running_ubun_as_user_vm -Service VM Tutorials -******************** - -.. toctree:: - :maxdepth: 1 - - tutorials/using_ubuntu_as_sos - tutorials/running_deb_as_serv_vm - Enable ACRN Features ******************** @@ -77,3 +71,34 @@ Enable ACRN Features tutorials/waag-secure-boot tutorials/enable_s5 tutorials/cpu_sharing + +Debug +***** + +.. toctree:: + :maxdepth: 1 + + tutorials/debug + tutorials/realtime_performance_tuning + +Additional Tutorials +******************** + +.. toctree:: + :maxdepth: 1 + + tutorials/up2 + tutorials/increase-uos-disk-size + tutorials/sign_clear_linux_image + tutorials/static-ip + tutorials/using_partition_mode_on_nuc + tutorials/using_partition_mode_on_up2 + tutorials/using_sdc2_mode_on_nuc + tutorials/using_hybrid_mode_on_nuc + tutorials/kbl-nuc-sdc + tutorials/enable_laag_secure_boot + tutorials/building_acrn_in_docker + tutorials/acrn_ootb + tutorials/run_kata_containers + user-guides/acrn-shell + user-guides/kernel-parameters \ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst index 5c470b0ba..e0b7839e1 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -81,7 +81,6 @@ license. try develop contribute - reference/index release_notes/index asa faq diff --git a/doc/learn.rst b/doc/learn.rst index 20fba4e35..3635dc695 100644 --- a/doc/learn.rst +++ b/doc/learn.rst @@ -1,7 +1,7 @@ .. _learn_acrn: -Learn about ACRN -################ +What is ACRN +############ ACRN is supported on Apollo Lake and Kaby Lake Intel platforms, as described in :ref:`hardware`. diff --git a/doc/reference/index.rst b/doc/reference/index.rst index 656433e0a..78b97cc81 100644 --- a/doc/reference/index.rst +++ b/doc/reference/index.rst @@ -1,3 +1,5 @@ +:orphan: + .. _reference: Developer references diff --git a/doc/try.rst b/doc/try.rst index a643c3d81..73fdd1877 100644 --- a/doc/try.rst +++ b/doc/try.rst @@ -1,7 +1,7 @@ .. _getting_started: -Try using ACRN -############## +Getting Started +############### After reading the :ref:`introduction`, use these guides to get started using ACRN in a reference setup. We'll show how to set up your