NASA-IMPACT / NASA-IMPACT/veda-docs
Should the docs be consistent about how to access STAC?
@jsignell is already working on this.
Since Jul 30, 2025.
- Dominant language
- Jupyter Notebook
- Stars
- 10
- Forks
- 16
- Avg merge
- 2d 31m
- Merged PRs (30d)
- 4
Description
The docs currently do a mixture of things. Some use pystac-client, some use requests.
The logic around which does which is roughly if you are going to be using requests in other parts of the notebook then you can just use requests in the STAC search part. The idea there is that it is useful to show how you can use to use STAC as a REST API. This is what you need to know about if you are building stories for the website. If we think people should genuinely be using titiler in a notebook then it probably deserves to have its own client library.
So the logic is kind of:
- if it is about using titiler (which doesn't have a client library and therefore uses requests) then use requests for STAC (example: https://github.com/NASA-IMPACT/veda-docs/blob/7482b2f0aec4c4ff474050bf69c2575f2f57f0d5/user-guide/notebooks/quickstarts/no2-map-plot.ipynb)
- if it is about accessing the data itself then use pystac-client (example: https://github.com/NASA-IMPACT/veda-docs/blob/7482b2f0aec4c4ff474050bf69c2575f2f57f0d5/user-guide/notebooks/quickstarts/open-and-plot.ipynb)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.