Structure docs

.github/workflows/docs.yml

@@ -0,0 +1,58 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  # Comment out unless for testing
+  # pull_request:
+  #   branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
+        with:
+          fetch-depth: 1
+
+      - name: Install a specific version of uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          version: "0.5.x"
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Build docs
+        run: uv run -- mkdocs build --strict
+
+      - name: Upload artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
+        with:
+          path: ./site
+          retention-days: 1
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
+        timeout-minutes: 10

docs/datacube-benchmark/api.md → docs/api-reference/datacube-benchmark.md

@@ -1,4 +1,4 @@
-# API Documentation
+# Datacube access
 
 ::: datacube_benchmark.utils.array_storage_size
 
@@ -16,20 +16,4 @@
 
 ::: datacube_benchmark.benchmark_statistics
 
-::: datacube_benchmark.tiling_benchmark_summary
-
-::: datacube_benchmark.TiTilerCMRBenchmarker
-
-::: datacube_benchmark.tiling.DatasetParams
-
 ::: datacube_benchmark.types.TARGET_SHAPES
-
-## General Tiling Utilities
-
-::: datacube_benchmark.tiling.get_surrounding_tiles
-
-::: datacube_benchmark.tiling.fetch_tile
-
-::: datacube_benchmark.tiling.get_tileset_tiles
-
-::: datacube_benchmark.tiling.create_bbox_feature

docs/api-reference/titiler-benchmark.md

@@ -0,0 +1,15 @@
+# Dynamic tiling
+
+::: datacube_benchmark.tiling_benchmark_summary
+
+::: datacube_benchmark.TiTilerCMRBenchmarker
+
+::: datacube_benchmark.tiling.DatasetParams
+
+::: datacube_benchmark.tiling.get_surrounding_tiles
+
+::: datacube_benchmark.tiling.fetch_tile
+
+::: datacube_benchmark.tiling.get_tileset_tiles
+
+::: datacube_benchmark.tiling.create_bbox_feature

docs/api-reference/titiler/index.md

@@ -0,0 +1,61 @@
+# TiTiler API Reference
+
+This section provides interactive API documentation for the TiTiler ecosystem components. Each application has its own specialized API while sharing common patterns from the core framework.
+
+## Available Applications
+
+<div class="grid cards" markdown>
+
+-   **TiTiler Core**
+
+    ---
+
+    Foundation API for COGs and STAC items. Base functionality that all other applications extend.
+
+    [:octicons-arrow-right-24: Core API Reference](titiler-core.md)
+
+-   **TiTiler CMR**
+
+    ---
+
+    NASA CMR-focused application for satellite data collections with time series support.
+
+    [:octicons-arrow-right-24: CMR API Reference](titiler-cmr.md)
+
+-   **TiTiler Multidim**
+
+    ---
+
+    Multi-dimensional dataset processing for NetCDF, Zarr, and scientific data formats.
+
+    [:octicons-arrow-right-24: Multidim API Reference](titiler-multidim.md)
+
+</div>
+
+## Common API Patterns
+
+All TiTiler applications follow consistent patterns:
+
+### Authentication
+- **API Keys**: Some endpoints require authentication via API keys
+- **CORS**: Cross-Origin Resource Sharing is configured for web applications
+- **Rate Limiting**: Default rate limits may apply
+
+### Response Formats
+- **JSON**: Metadata, statistics, and configuration responses
+- **Images**: PNG, JPEG, WebP tiles and previews
+- **GeoJSON**: Spatial data responses
+- **HTML**: Interactive viewers and documentation
+
+### Error Handling
+- **HTTP Status Codes**: Standard codes (200, 400, 404, 500, etc.)
+- **Error Messages**: Detailed error descriptions in JSON format
+- **Validation**: Parameter validation with helpful error messages
+
+### Performance
+- **Caching**: Response caching for improved performance
+- **Compression**: Automatic response compression
+- **Streaming**: Efficient data streaming for large responses
+
+!!! tip "Testing APIs"
+    Use the embedded interactive documentation to test endpoints directly in your browser. Each API reference page includes a full interactive interface for exploring available endpoints and parameters.

docs/api-reference/titiler/titiler-cmr.md

@@ -0,0 +1,37 @@
+# TiTiler CMR API Reference
+
+TiTiler CMR is a NASA-focused application that accepts Concept IDs and uses the Common Metadata Repository (CMR) to discover and serve associated granules as tiles.
+
+## Key Features
+
+- **CMR Integration**: Direct integration with NASA's Common Metadata Repository
+- **Earth Science Data**: Specialized for NASA Earth science data collections
+- **Time Series Support**: Built-in temporal analysis capabilities
+- **Granule Discovery**: Automatic discovery and aggregation of data granules
+
+## Interactive API Documentation
+
+The complete, interactive API documentation from the OpenVEDA Cloud deployment is below. Please be kind with this API.
+
+<iframe src="https://staging.openveda.cloud/api/titiler-cmr/api.html"
+        width="100%"
+        height="800px"
+        frameborder="0"
+        style="border: 1px solid #ddd; border-radius: 4px;">
+</iframe>
+
+## Quick Links
+
+- [Open API docs in new tab](https://staging.openveda.cloud/api/titiler-cmr/api.html){:target="_blank"}
+- [OpenAPI Schema JSON](https://staging.openveda.cloud/api/titiler-cmr/api){:target="_blank"}
+
+## Main Endpoint Categories
+
+- **Collections**: `/collections/{collection_id}` - Work with CMR collections
+- **Statistics**: `/collections/{collection_id}/statistics` - Extract statistical data
+- **Time Series**: `/collections/{collection_id}/timeseries` - Temporal analysis
+- **Tiles**: `/collections/{collection_id}/tiles` - Generate map tiles
+- **Items**: Individual granule access and processing
+
+!!! tip "Authentication"
+    Some endpoints may require authentication depending on the data collection's access restrictions.

docs/api-reference/titiler/titiler-core.md

@@ -0,0 +1,40 @@
+# TiTiler Core API Reference
+
+TiTiler Core provides the foundational API patterns used across all TiTiler applications. It handles Cloud Optimized GeoTIFFs (COGs) and SpatioTemporal Asset Catalog (STAC) items.
+
+## Key Features
+
+- **COG Support**: Optimized Cloud Optimized GeoTIFF processing
+- **STAC Integration**: Full SpatioTemporal Asset Catalog support
+- **OGC Compliance**: Standards-compliant tile serving
+- **Extensible Architecture**: Foundation for specialized applications
+- **High Performance**: Optimized for cloud-native workflows
+
+## Interactive API Documentation
+
+The complete, interactive API documentation from the Development demo deployment is below. Please be kind with this API.
+
+<iframe src="https://titiler.xyz/api.html"
+        width="100%"
+        height="800px"
+        frameborder="0"
+        style="border: 1px solid #ddd; border-radius: 4px;">
+</iframe>
+
+## Quick Links
+
+- [Open API docs in new tab](https://titiler.xyz/api.html){:target="_blank"}
+- [OpenAPI Schema JSON](https://titiler.xyz/api){:target="_blank"}
+- [TiTiler Demo Landing Page](https://titiler.xyz/){:target="_blank"}
+
+## Main Endpoint Categories
+
+- **COG Endpoints**: `/cog/*` - Cloud Optimized GeoTIFF processing
+- **STAC Endpoints**: `/stac/*` - SpatioTemporal Asset Catalog integration
+- **Mosaic Endpoints**: `/mosaicjson/*` - Multi-source mosaicking
+- **Algorithms**: `/algorithms` - Available processing algorithms
+- **Color Maps**: `/colorMaps` - Available visualization color schemes
+- **TMS**: `/tileMatrixSets` - Supported tiling schemes
+
+!!! info "Foundation Layer"
+    TiTiler Core serves as the foundation that all other TiTiler applications build upon, providing consistent API patterns and core functionality.

docs/api-reference/titiler/titiler-multidim.md

@@ -0,0 +1,39 @@
+# TiTiler Multidim API Reference
+
+TiTiler Multidim is a comprehensive application built on `titiler.xarray` specifically designed for multi-dimensional datasets like NetCDF and Zarr files.
+
+## Key Features
+
+- **Multi-dimensional Support**: Native handling of 3D, 4D, and 5D datasets
+- **Temporal Processing**: Advanced time-series analysis and animation support
+- **Performance Optimizations**: Redis caching and optimized chunking strategies
+- **Scientific Data Formats**: NetCDF, Zarr, HDF, and other research data formats
+- **VEDA Integration**: Optimized for NASA's VEDA platform infrastructure
+
+## Interactive API Documentation
+
+The complete, interactive API documentation from the OpenVEDA Cloud deployment is below. Please be kind with this API.
+
+<iframe src="https://staging.openveda.cloud/api/titiler-multidim/api.html"
+        width="100%"
+        height="800px"
+        frameborder="0"
+        style="border: 1px solid #ddd; border-radius: 4px;">
+</iframe>
+
+## Quick Links
+
+- [Open API docs in new tab](https://staging.openveda.cloud/api/titiler-multidim/api.html){:target="_blank"}
+- [OpenAPI Schema JSON](https://staging.openveda.cloud/api/titiler-multidim/api){:target="_blank"}
+
+## Main Endpoint Categories
+
+- **Dataset Info**: `/info` - Dataset metadata and structure
+- **Statistics**: `/statistics` - Statistical analysis across dimensions
+- **Tiles**: `/tiles/{z}/{x}/{y}` - Map tile generation
+- **Temporal Selection**: Time-based data slicing and selection
+- **Dimensional Analysis**: Multi-dimensional data exploration
+- **Rendering**: Advanced visualization and color mapping
+
+!!! note "Prototype Application"
+    TiTiler Multidim serves as a prototype application demonstrating advanced multidimensional data processing capabilities with various optimizations for production use.