Skip to content

Feat/reorg documentation#109

Merged
abarciauskas-bgse merged 31 commits intodevelopfrom
feat/reorg-documentation
Feb 13, 2026
Merged

Feat/reorg documentation#109
abarciauskas-bgse merged 31 commits intodevelopfrom
feat/reorg-documentation

Conversation

@abarciauskas-bgse
Copy link
Copy Markdown
Contributor

@abarciauskas-bgse abarciauskas-bgse commented Jan 8, 2026

This PR restructures the documentation both to group notebooks under similar headings and to incorporate some of the notebooks that were previously in the Datacube Guide, but were about TiTiler-CMR.

The new structure (and some revised content) can be reviewed here: https://developmentseed.org/titiler-cmr/feat-reorg-documentation/

For future work (I can make these tickets if you agree @hrodmn )

  • titiler-cmr-statistics-benchmark.ipynb - I proposed that this go under benchmark/statistics but when re-running this I got zero statistics points returned and couldn't fix it after about an hour of finagling, so I removed it for now.
  • compatibility/tool.ipynb - we probably want to modify this content and the compatibility tool further to say compatibility cannot be determined if 0 timesteps are returned.
  • Update the time series api limits documentation given we are now using a container

Todo:

  • delete branch from documentation's dropdown upon branch merge or delete

@review-notebook-app
Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@abarciauskas-bgse abarciauskas-bgse marked this pull request as ready for review January 12, 2026 15:41
Copy link
Copy Markdown
Contributor

@hrodmn hrodmn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@abarciauskas-bgse thanks so much for the docs reorganization effort. I like the new structure! The main issue I see now is just that the notebooks that use the datacube_benchmark python package are not able to render properly because the package could not be imported when mkdocs rendered the site. I haven't dug in to see what is going on there - hopefully there is a simple fix!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should remove this file and make sure all of these dependencies are present in the docs group in the project-level pyproject.toml. That way everything would be ready to run when we run uv run --group docs mkdocs ...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it makes sense to leave it in as datacube_benchmark can then be installed as a standalone package, but let me know if you see it differently

- api/sel_parameter_example.ipynb
- Benchmarking:
- benchmarking/tiles.ipynb
- benchmarking/hls_tiling.ipynb
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the HLS notebook really belongs under the 'benchmarking' header. Maybe we could just rename Benchmarking to Advanced so interested readers can open it to find more without declaring an overall theme.

Comment on lines +32 to +33
- api/time_series_example.ipynb
- api/time_series_api_limits.ipynb
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not blocking but we could just add the time series api limits notebook contents to the the main time series notebook. I'm not sure it needs to be a separate page.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think they make sense as separate notebooks, since the limits notebook has explicit limits described

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the notebooks that use the datacube_benchmark python package are failing to render because it can't import the package :/

@abarciauskas-bgse
Copy link
Copy Markdown
Contributor Author

@hrodmn thanks for your review! I think I have addressed your comments, let me know what you think 🙏🏽

@hrodmn
Copy link
Copy Markdown
Contributor

hrodmn commented Feb 4, 2026

@abarciauskas-bgse I think the changes all look good but the rendered docs site is exposing some problems in the new production deployment so I think we should switch the notebooks back to using the staging endpoint for now.

@abarciauskas-bgse
Copy link
Copy Markdown
Contributor Author

@hrodmn thank you for noticing that! I have replaced all instances of the production endpoint with the staging endpoint in a6d1caf and looking at developmentseed.org/titiler-cmr/feat-reorg-documentation I believe the issues are resolved by using the staging endpoint.

@abarciauskas-bgse abarciauskas-bgse self-assigned this Feb 9, 2026
@abarciauskas-bgse abarciauskas-bgse merged commit 8c44c15 into develop Feb 13, 2026
5 checks passed
@abarciauskas-bgse abarciauskas-bgse deleted the feat/reorg-documentation branch February 13, 2026 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants