paleolimbot commented on code in PR #66:
URL: https://github.com/apache/sedona-db/pull/66#discussion_r2353982019
##########
.github/workflows/lint.yml:
##########
Review Comment:
Can you remove this? (We have this set up already in workflows/dev.yaml!)
##########
.pre-commit-config.yaml:
##########
@@ -57,3 +57,16 @@ repos:
types_or: [c, c++]
# Don't run on vendored files
exclude:
"^c/(sedona-geoarrow-c/src/geoarrow|sedona-geoarrow-c/src/nanoarrow|sedona-tg/src/tg)/.*"
+
+ - repo: local
+ hooks:
+ - id: jupyter-nbconvert
+ name: Convert Jupyter Notebook to Markdown
+ # IMPORTANT: Change the path below to your actual notebook file
+ entry: jupyter nbconvert --to markdown --execute
docs/quickstart-python.ipynb
+ language: system
+ types: [jupyter]
+ # This ensures the hook only runs when this specific notebook changes
+ files: ^docs/quickstart-python.ipynb$
+ # Always run this hook at the commit stage
+ stages: [pre-commit]
Review Comment:
Can you remove this? I would like to avoid executing code that relies on
build artifacts since I run this many times a day! I will set up the script
that automatically renders notebooks in a separate PR.
##########
docs/quickstart-python.md:
##########
@@ -0,0 +1,229 @@
+# Python Quickstart
Review Comment:
I think the notebook is here and this file was rendered from it! I think
that's the best approach for now.
##########
docs/requirements.txt:
##########
@@ -1,9 +1,12 @@
+jupyter
mike
mkdocs-git-revision-date-localized-plugin
mkdocs-glightbox
mkdocs-jupyter
mkdocs-macros-plugin
mkdocs-material
mkdocstrings[python]
+nbconvert
ruff
+pre-commit
Review Comment:
```suggestion
```
(This gets installed in CI on every commit, so I'd like to remove any
dependencies that aren't strictly required to run `build-docs.sh`).
##########
docs/index.md:
##########
@@ -22,13 +24,30 @@ hide:
under the License.
-->
-# SedonaDB
+SedonaDB is a high-performance, dependency-free geospatial compute engine
designed for single-node processing, making it ideal for smaller datasets on
local machines or cloud instances.
+
+The initial `0.1` release supports a core set of vector operations, with
comprehensive vector and raster computation capabilities planned for the near
future.
+
+## Key features
+
+SedonaDB has several advantages:
+
+* **Blazing-Fast Performance:** Built in Rust to process massive geospatial
datasets with exceptional speed.
Review Comment:
```suggestion
* **Performance:** Built in Rust to process massive geospatial datasets with
exceptional speed.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
