diff --git a/conf.py b/conf.py index 640bc21..1465232 100755 --- a/conf.py +++ b/conf.py @@ -153,6 +153,9 @@ import pydata_sphinx_theme html_theme = "pydata_sphinx_theme" html_theme_options = { + "logo": { + "link": "introduction/index", + }, "github_url": "https://github.com/thesofproject/sof", "external_links": [ {"name": "SOF Project Website", "url": "https://sofproject.org"} diff --git a/index.rst b/index.rst index db78294..cd3aebe 100644 --- a/index.rst +++ b/index.rst @@ -1,38 +1,23 @@ -.. _SOF_home: - -Sound Open Firmware Documentation -################################# +.. meta:: + :http-equiv=Refresh: 0; url=introduction/index.html -Welcome to the **Sound Open Firmware (SOF)** technical documentation portal (version |version|). +.. raw:: html -Sound Open Firmware is a permissively licensed, open-source audio DSP firmware, SDK, and Linux/Zephyr audio framework providing vendor-independent, transparent audio processing infrastructure across diverse DSP hardware architectures. + -.. note:: - Looking for high-level project announcements, community blogs, and events? Visit the main `SOF Project Website `_. +.. _SOF_home: -Overview & Quick Navigation -*************************** +Sound Open Firmware Documentation +################################# -* :ref:`Getting Started ` - Set up your build environment, compile firmware for target platforms, and run tests in simulation. -* :ref:`Architecture & System Design ` - End-to-end system design: Host Linux ASoC drivers, IPC protocols (IPC3/IPC4), Zephyr RTOS integration, and memory paging. -* :ref:`Supported Platforms Matrix ` - Hardware compatibility list spanning Intel CAVS/ACE, AMD, NXP, MediaTek, Teensy 4.1, and ESP32-P4 bridges. -* :ref:`Audio Algorithms & Features ` - Processing modules catalog: Volume, Mixer, SRC, EQ, DRC, AEC, Beamforming, WoV, AAC/MP3 VFPU, and Steam Audio. -* :ref:`Developer Guides ` - Deep-dives into Topology 2, LLEXT dynamic module loading, real-time trace probing, and debugging. -* :ref:`API Reference ` - Doxygen-generated C API documentation for firmware interfaces, components, and driver ABIs. -* :ref:`Frequently Asked Questions (FAQ) ` - Quick answers to architectural, algorithmic, hardware compatibility, simulation, and licensing questions. +.. raw:: html -Documentation Sections -********************** +

Redirecting to Introduction to the SOF Project...

.. toctree:: - :maxdepth: 1 + :hidden: SOF Project Website introduction/index.rst @@ -48,3 +33,4 @@ Documentation Sections api/index.rst presentations/index.rst faq/index.rst + diff --git a/scripts/publish-index.html b/scripts/publish-index.html index 1f07fee..20d954d 100644 --- a/scripts/publish-index.html +++ b/scripts/publish-index.html @@ -1,10 +1,13 @@ SOF Project documentation - + + -Please visit the latest SOF documentation +Please visit the latest SOF documentation