Proposed changes to titiler-cmr documentation (merging in sections from datacube guide)

[abarciauskas-bgse]

This issue is to propose some changes to the titiler-cmr documentation's outline, in large part to incorporate the benchmarking and compatibility work in the datacube guide.

Current titiler-cmr documentation

• Home
• Examples
  • xarray backend: MUR SST
  • rasterio backend example: HLS
  • time series API
• Dataset configuration
  • Harmonized Landsat Sentinel 2 (HLS): tiling configuration and rendering performance
• Deployment
  • Time series API limits
• Development - Contributing
• Release notes
• TiTiler-CMR Compatibility Report

💡 Proposed titiler-cmr documentation outline

• Home
• How to (API documentation)
  • Compatibility API: Determine if a dataset is compatible and what parameters to use
    • Extract example code from MUR SST example linked below
  • Tiles API: How to tile a dataset
    • xarray backend: MUR SST
    • rasterio backend example: HLS
  • Statistics API: Generate statistics
    • Extract example code from MUR SST example linked above
  • Timeseries API: Generate a timeseries
    • Time series API
    • Time series API limits
• Benchmarking
  • Benchmarking tile generation (datacube guide)
  • Benchmark Statistics (datacube guide)
  • Example: Harmonized Landsat Sentinel 2 (HLS): tiling configuration and rendering performance
• Compatibility Testing
  • TiTiler-CMR Compatibility Report (comprehensive tiling report)
  • Timeseries/statistics compatibility testing tool (datacube guide)

If you agree, I will probably do this incrementally as I want to run through the documentation being pulled over from the datacube guide. Steps:

• Do the reorg with placeholder pages that point to the datacube guide pages
• Review + incorporate benchmark tile generation
• Review + incorporate benchmark stats
• Review + incorporate Timeseries/statistics compatibility testing tool
• Remove the titiler-cmr section from the datacube guide

WDYT @hrodmn @maxrjones?

FYI @negin513

[abarciauskas-bgse]

Merging and re-writing some of the content which is similar but having distinct implementations (e.g. the benchmarking and compatibility sections being merged from the datacube guide) would be nice but is out of scope for this effort 😄