This is an automated email from the ASF dual-hosted git repository.
agrove pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-comet.git
The following commit(s) were added to refs/heads/main by this push:
new dfcabb452 docs: Improve site navigation (#2597)
dfcabb452 is described below
commit dfcabb452d7b62d2e6ef6adc24906bd200dd4909
Author: Andy Grove <[email protected]>
AuthorDate: Thu Oct 16 20:51:52 2025 -0600
docs: Improve site navigation (#2597)
---
docs/source/{ => about}/gluten_comparison.md | 2 +-
docs/source/{overview.md => about/index.md} | 46 ++++++++++++++-----------
docs/source/asf/index.md | 32 +++++++++++++++++
docs/source/conf.py | 6 ++--
docs/source/contributor-guide/index.md | 37 ++++++++++++++++++++
docs/source/index.md | 51 +++-------------------------
docs/source/user-guide/index.md | 31 +++++++++++++++++
7 files changed, 137 insertions(+), 68 deletions(-)
diff --git a/docs/source/gluten_comparison.md
b/docs/source/about/gluten_comparison.md
similarity index 98%
rename from docs/source/gluten_comparison.md
rename to docs/source/about/gluten_comparison.md
index 32015a81b..8017cc7d0 100644
--- a/docs/source/gluten_comparison.md
+++ b/docs/source/about/gluten_comparison.md
@@ -64,7 +64,7 @@ Comet relies on the full Spark SQL test suite (consisting of
more than 24,000 te
integration tests to ensure compatibility with Spark. Features that are known
to have compatibility differences with
Spark are disabled by default, but users can opt in. See the [Comet
Compatibility Guide] for more information.
-[Comet Compatibility Guide]: user-guide/latest/compatibility.md
+[Comet Compatibility Guide]: /user-guide/latest/compatibility.md
Gluten also aims to provide compatibility with Spark, and includes a subset of
the Spark SQL tests in its own test
suite. See the [Gluten Compatibility Guide] for more information.
diff --git a/docs/source/overview.md b/docs/source/about/index.md
similarity index 62%
rename from docs/source/overview.md
rename to docs/source/about/index.md
index 1b5ed1e97..43d25f8db 100644
--- a/docs/source/overview.md
+++ b/docs/source/about/index.md
@@ -1,20 +1,20 @@
-<!---
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
-->
# Comet Overview
@@ -53,7 +53,7 @@ There are two other major open-source Spark accelerators:
We have a detailed guide [comparing Apache DataFusion Comet with Apache
Gluten].
-Spark RAPIDS is a solution that provides hardware acceleration on NVIDIA GPUs.
Comet does not require specialized
+Spark RAPIDS is a solution that provides hardware acceleration on NVIDIA GPUs.
Comet does not require specialized
hardware.
[comparing Apache DataFusion Comet with Apache Gluten]: gluten_comparison.md
@@ -62,4 +62,12 @@ hardware.
Refer to the [Comet Installation Guide] to get started.
-[Comet Installation Guide]: user-guide/latest/installation.md
+[Comet Installation Guide]: /user-guide/latest/installation.md
+
+```{toctree}
+:maxdepth: 1
+:caption: About
+:hidden:
+
+Comparison with Gluten <gluten_comparison>
+```
diff --git a/docs/source/asf/index.md b/docs/source/asf/index.md
new file mode 100644
index 000000000..3d7c9810d
--- /dev/null
+++ b/docs/source/asf/index.md
@@ -0,0 +1,32 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# ASF Links
+
+```{toctree}
+:maxdepth: 1
+:caption: ASF Links
+
+Apache Software Foundation <https://apache.org>
+License <https://www.apache.org/licenses/>
+Donate <https://www.apache.org/foundation/sponsorship.html>
+Thanks <https://www.apache.org/foundation/thanks.html>
+Security <https://www.apache.org/security/>
+Code of conduct <https://www.apache.org/foundation/policies/conduct.html>
+```
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 245071eed..09afea88e 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -141,8 +141,10 @@ myst_heading_anchors = 3
myst_enable_extensions = ["colon_fence", "deflist", "tasklist"]
redirects = {
- "user-guide/overview.html": "../overview.html",
- "user-guide/gluten_comparison.html": "../gluten_comparison.html",
+ "overview.html": "about/overview.html",
+ "gluten_comparison.html": "about/gluten_comparison.html",
+ "user-guide/overview.html": "../about/overview.html",
+ "user-guide/gluten_comparison.html": "../about/gluten_comparison.html",
"user-guide/compatibility.html": "latest/compatibility.html",
"user-guide/configs.html": "latest/configs.html",
"user-guide/datasource.html": "latest/datasource.html",
diff --git a/docs/source/contributor-guide/index.md
b/docs/source/contributor-guide/index.md
new file mode 100644
index 000000000..d4b4e185e
--- /dev/null
+++ b/docs/source/contributor-guide/index.md
@@ -0,0 +1,37 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Comet Contributor Guide
+
+```{toctree}
+:maxdepth: 2
+:caption: Contributor Guide
+
+Getting Started <contributing>
+Comet Plugin Overview <plugin_overview>
+Development Guide <development>
+Debugging Guide <debugging>
+Benchmarking Guide <benchmarking>
+Adding a New Expression <adding_a_new_expression>
+Tracing <tracing>
+Profiling Native Code <profiling_native_code>
+Spark SQL Tests <spark-sql-tests.md>
+Roadmap <roadmap.md>
+Github and Issue Tracker <https://github.com/apache/datafusion-comet>
+```
diff --git a/docs/source/index.md b/docs/source/index.md
index 9310ff0c6..7aa124a58 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -97,52 +97,11 @@ shaping the future of Comet. Check out our
```{toctree}
:maxdepth: 1
-:caption: Overview
+:caption: Index
:hidden:
-Comet Overview <overview>
-Comparison with Gluten <gluten_comparison>
-```
-
-```{toctree}
-:maxdepth: 2
-:caption: User Guides
-:hidden:
-
-0.12.0-SNAPSHOT <user-guide/latest/index>
-0.11.x <user-guide/0.11/index>
-0.10.x <user-guide/0.10/index>
-0.9.x <user-guide/0.9/index>
-0.8.x <user-guide/0.8/index>
-```
-
-```{toctree}
-:maxdepth: 1
-:caption: Contributor Guide
-:hidden:
-
-Getting Started <contributor-guide/contributing>
-Comet Plugin Overview <contributor-guide/plugin_overview>
-Development Guide <contributor-guide/development>
-Debugging Guide <contributor-guide/debugging>
-Benchmarking Guide <contributor-guide/benchmarking>
-Adding a New Expression <contributor-guide/adding_a_new_expression>
-Tracing <contributor-guide/tracing>
-Profiling Native Code <contributor-guide/profiling_native_code>
-Spark SQL Tests <contributor-guide/spark-sql-tests.md>
-Roadmap <contributor-guide/roadmap.md>
-Github and Issue Tracker <https://github.com/apache/datafusion-comet>
-```
-
-```{toctree}
-:maxdepth: 1
-:caption: ASF Links
-:hidden:
-
-Apache Software Foundation <https://apache.org>
-License <https://www.apache.org/licenses/>
-Donate <https://www.apache.org/foundation/sponsorship.html>
-Thanks <https://www.apache.org/foundation/thanks.html>
-Security <https://www.apache.org/security/>
-Code of conduct <https://www.apache.org/foundation/policies/conduct.html>
+Comet Overview <about/index>
+User Guide <user-guide/index>
+Contributor Guide <contributor-guide/index>
+ASF Links <asf/index>
```
diff --git a/docs/source/user-guide/index.md b/docs/source/user-guide/index.md
new file mode 100644
index 000000000..3cf6d53e0
--- /dev/null
+++ b/docs/source/user-guide/index.md
@@ -0,0 +1,31 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Comet User Guide
+
+```{toctree}
+:maxdepth: 2
+:caption: User Guides
+
+0.12.0-SNAPSHOT <latest/index>
+0.11.x <0.11/index>
+0.10.x <0.10/index>
+0.9.x <0.9/index>
+0.8.x <0.8/index>
+```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
