Skip to content

doc: redirect landing page and logo link to introduction #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgirdwood merged 1 commit into from
Sep 13, 2026
+21 −29
Merged

doc: redirect landing page and logo link to introduction #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
Expand Down
40 changes: 13 additions & 27 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
<script type="text/javascript">
window.location.replace("introduction/index.html");
</script>

.. note::
Looking for high-level project announcements, community blogs, and events? Visit the main `SOF Project Website <https://sofproject.org>`_.
.. _SOF_home:

Overview & Quick Navigation
***************************
Sound Open Firmware Documentation
#################################

* :ref:`Getting Started <getting_started>`
Set up your build environment, compile firmware for target platforms, and run tests in simulation.
* :ref:`Architecture & System Design <architectures>`
End-to-end system design: Host Linux ASoC drivers, IPC protocols (IPC3/IPC4), Zephyr RTOS integration, and memory paging.
* :ref:`Supported Platforms Matrix <platforms>`
Hardware compatibility list spanning Intel CAVS/ACE, AMD, NXP, MediaTek, Teensy 4.1, and ESP32-P4 bridges.
* :ref:`Audio Algorithms & Features <algos>`
Processing modules catalog: Volume, Mixer, SRC, EQ, DRC, AEC, Beamforming, WoV, AAC/MP3 VFPU, and Steam Audio.
* :ref:`Developer Guides <developer_guides>`
Deep-dives into Topology 2, LLEXT dynamic module loading, real-time trace probing, and debugging.
* :ref:`API Reference <api>`
Doxygen-generated C API documentation for firmware interfaces, components, and driver ABIs.
* :ref:`Frequently Asked Questions (FAQ) <faq>`
Quick answers to architectural, algorithmic, hardware compatibility, simulation, and licensing questions.
.. raw:: html

Documentation Sections
**********************
<p>Redirecting to <a href="introduction/index.html">Introduction to the SOF Project</a>...</p>

.. toctree::
:maxdepth: 1
:hidden:

SOF Project Website <https://sofproject.org>
introduction/index.rst
Expand All @@ -48,3 +33,4 @@ Documentation Sections
api/index.rst
presentations/index.rst
faq/index.rst

7 changes: 5 additions & 2 deletions scripts/publish-index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
<html>
<head>
<title>SOF Project documentation</title>
<meta http-equiv="refresh" content="0; URL=latest/index.html">
<meta http-equiv="refresh" content="0; URL=latest/introduction/index.html">
<meta name="keywords" content="automatic redirection">
<script type="text/javascript">
window.location.replace("latest/introduction/index.html");
</script>
</head>
<body>
Please visit the <a href="/latest/">latest SOF documentation</a>
Please visit the <a href="latest/introduction/index.html">latest SOF documentation</a>
</body>
</html>
Loading