Skip to content

Commit cd68cd3

Browse files
lrgirdwolgirdwood
authored andcommitted
doc: redirect landing page and logo link to introduction
- Set docutils meta http-equiv Refresh and JavaScript replace in index.rst to redirect /latest/ and /latest/index.html directly to introduction/index.html. - Configure pydata theme logo link to introduction/index so clicking the header logo navigates directly to the Introduction page. - Update scripts/publish-index.html to redirect root https://thesofproject.github.io/ directly to latest/introduction/index.html. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
1 parent e75c34e commit cd68cd3

3 files changed

Lines changed: 21 additions & 29 deletions

File tree

‎conf.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,9 @@
153153
import pydata_sphinx_theme
154154
html_theme = "pydata_sphinx_theme"
155155
html_theme_options = {
156+
"logo": {
157+
"link": "introduction/index",
158+
},
156159
"github_url": "https://github.com/thesofproject/sof",
157160
"external_links": [
158161
{"name": "SOF Project Website", "url": "https://sofproject.org"}

‎index.rst‎

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,23 @@
1-
.. _SOF_home:
2-
3-
Sound Open Firmware Documentation
4-
#################################
1+
.. meta::
2+
:http-equiv=Refresh: 0; url=introduction/index.html
53

6-
Welcome to the **Sound Open Firmware (SOF)** technical documentation portal (version |version|).
4+
.. raw:: html
75

8-
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.
6+
<script type="text/javascript">
7+
window.location.replace("introduction/index.html");
8+
</script>
99

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

13-
Overview & Quick Navigation
14-
***************************
12+
Sound Open Firmware Documentation
13+
#################################
1514

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

31-
Documentation Sections
32-
**********************
17+
<p>Redirecting to <a href="introduction/index.html">Introduction to the SOF Project</a>...</p>
3318

3419
.. toctree::
35-
:maxdepth: 1
20+
:hidden:
3621

3722
SOF Project Website <https://sofproject.org>
3823
introduction/index.rst
@@ -48,3 +33,4 @@ Documentation Sections
4833
api/index.rst
4934
presentations/index.rst
5035
faq/index.rst
36+

‎scripts/publish-index.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
<html>
22
<head>
33
<title>SOF Project documentation</title>
4-
<meta http-equiv="refresh" content="0; URL=latest/index.html">
4+
<meta http-equiv="refresh" content="0; URL=latest/introduction/index.html">
55
<meta name="keywords" content="automatic redirection">
6+
<script type="text/javascript">
7+
window.location.replace("latest/introduction/index.html");
8+
</script>
69
</head>
710
<body>
8-
Please visit the <a href="/latest/">latest SOF documentation</a>
11+
Please visit the <a href="latest/introduction/index.html">latest SOF documentation</a>
912
</body>
1013
</html>

0 commit comments

Comments
 (0)