This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sedona-spatialbench.git
The following commit(s) were added to refs/heads/main by this push:
new ca4c313 [DOCS] Adding mkdocs material (#4)
ca4c313 is described below
commit ca4c3133e43a72e788b6119b2f4cedfff70fd93c
Author: Kelly-Ann Dolor <[email protected]>
AuthorDate: Mon Sep 8 11:35:19 2025 -0700
[DOCS] Adding mkdocs material (#4)
* [DOCS] WIP SpatialBench docs repo
* [DOCS] WIP SpatialBench docs repo
* adding docs requirements file
* Update mkdocs.yml
Co-authored-by: Copilot <[email protected]>
* Update mkdocs.yml
Co-authored-by: Copilot <[email protected]>
* Update mkdocs.yml
Co-authored-by: Copilot <[email protected]>
* Update mkdocs.yml
Co-authored-by: Copilot <[email protected]>
---------
Co-authored-by: Copilot <[email protected]>
---
docs/get-started/data-model.md | 1 +
docs/get-started/overview.md | 11 +++++
docs/get-started/performance.md | 1 +
docs/index.md | 3 ++
mkdocs.yml | 102 ++++++++++++++++++++++++++++++++++++++++
requirements-docs.txt | 7 +++
6 files changed, 125 insertions(+)
diff --git a/docs/get-started/data-model.md b/docs/get-started/data-model.md
new file mode 100644
index 0000000..008c096
--- /dev/null
+++ b/docs/get-started/data-model.md
@@ -0,0 +1 @@
+# Data Model
diff --git a/docs/get-started/overview.md b/docs/get-started/overview.md
new file mode 100644
index 0000000..97b0dc1
--- /dev/null
+++ b/docs/get-started/overview.md
@@ -0,0 +1,11 @@
+SpatialBench is a high-performance geospatial benchmark for generating
synthetic spatial data at scale. Inspired by the Star Schema Benchmark (SSB)
and real-world mobility data like the NYC TLC dataset, SpatialBench is designed
to evaluate spatial query performance in modern data platforms.
+
+Built in Rust and powered by Apache Arrow, SpatialBench brings fast, scalable,
and streaming-friendly data generation for spatial workloads—minimal
dependencies, blazing speed.
+
+SpatialBench provides a reproducible and scalable way to evaluate the
performance of spatial data engines using realistic synthetic workloads.
+
+Goals:
+
+Establish a fair and extensible benchmark suite for spatial data processing.
+Help users compare engines and frameworks across different data scales.
+Support open standards and foster collaboration in the spatial computing
community.
\ No newline at end of file
diff --git a/docs/get-started/performance.md b/docs/get-started/performance.md
new file mode 100644
index 0000000..6babb31
--- /dev/null
+++ b/docs/get-started/performance.md
@@ -0,0 +1 @@
+# Performance
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..9397315
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,3 @@
+# SpatialBench Documentation
+
+Space for writing SpatialBench Documentation.
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..343c537
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,102 @@
+# 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.
+
+site_name: SpatialBench
+site_description: SpatialBench is a high-performance geospatial benchmark for
generating synthetic spatial data at scale.
+nav:
+ - Home: index.md
+ - Get Started:
+ - Overview: get-started/overview.md
+ - Data Model: get-started/data-model.md
+ - Performance: get-started/performance.md
+theme:
+ font: false
+ name: 'material'
+ custom_dir: docs-overrides
+ palette:
+ primary: 'deep orange'
+ accent: 'green'
+ icon:
+ logo: fontawesome/solid/earth-americas
+ repo: fontawesome/brands/github
+ features:
+ - content.code.copy
+ - content.action.edit
+ - search.highlight
+ - search.share
+ - search.suggest
+ - navigation.footer
+ - navigation.instant
+ - navigation.tabs
+ - navigation.tabs.sticky
+ - navigation.top
+extra:
+ version:
+ provider: mike
+ default:
+ - latest
+ social:
+ - icon: fontawesome/brands/github
+ link: 'https://github.com/apache/spatialbench'
+ - icon: fontawesome/brands/twitter
+ link: 'https://twitter.com/ApacheSedona'
+ - icon: fontawesome/brands/discord
+ link: 'https://discord.gg/9A3k5dEBsY'
+# (Removed Sedona-specific version variables; no replacement needed)
+copyright: Copyright © 2025 The Apache Software Foundation. Apache Sedona,
Sedona, Apache, the Apache feather logo, and the Apache Sedona project logo are
either registered trademarks or trademarks of The Apache Software Foundation in
the United States and other countries. All other marks mentioned may be
trademarks or registered trademarks of their respective owners. Please visit <a
href="https://www.apache.org/";>Apache Software Foundation</a> for more
details.<img referrerpolicy="no-re [...]
+
+markdown_extensions:
+ - admonition
+ - attr_list
+ - codehilite
+ - toc:
+ permalink: true
+ toc_depth: 3
+ - pymdownx.arithmatex
+ - pymdownx.betterem:
+ smart_enable: all
+ - pymdownx.caret
+ - pymdownx.critic
+ - pymdownx.details
+ - pymdownx.emoji:
+ emoji_generator: !!python/name:pymdownx.emoji.to_svg
+ - pymdownx.inlinehilite
+ - pymdownx.magiclink
+ - pymdownx.mark
+ - pymdownx.smartsymbols
+ - pymdownx.superfences:
+ custom_fences:
+ - name: mermaid
+ class: mermaid
+ format: !!python/name:pymdownx.superfences.fence_code_format
+ - pymdownx.tabbed:
+ alternate_style: true
+ - pymdownx.tasklist:
+ custom_checkbox: true
+ - pymdownx.tilde
+plugins:
+ - search:
+ # prebuild_index: true
+ - macros
+ - git-revision-date-localized:
+ type: datetime
+ - mike:
+ canonical_version: 'latest'
+extra_css:
+ - assets/stylesheets/extra.css
+extra_javascript:
+ - assets/javascripts/main.min.js
diff --git a/requirements-docs.txt b/requirements-docs.txt
new file mode 100644
index 0000000..7f81021
--- /dev/null
+++ b/requirements-docs.txt
@@ -0,0 +1,7 @@
+mkdocs
+mkdocs-material
+mkdocs-macros-plugin
+mkdocs-glightbox
+mkdocs-git-revision-date-localized-plugin
+mike
+mkdocs-jupyter
