Skip to content

Updates and fixes to README, index, quickstart, and usage#792

Merged
gadomski merged 6 commits into
mainfrom
pv/docs
Apr 25, 2025
Merged

Updates and fixes to README, index, quickstart, and usage#792
gadomski merged 6 commits into
mainfrom
pv/docs

Conversation

@philvarner
Copy link
Copy Markdown
Collaborator

@philvarner philvarner commented Apr 19, 2025

Related Issue(s):

  • n/a

Description:

  • makes many references to "PySTAC Client" or "pystac-client" consistent
  • adds install directions for uv and poetry
  • fixes STAC Versions table in index (first row was missing a -, so that cell was rendered incorrectly
  • Updated Collection Search example to an API that actually supports it (ES & PC do not). pystac encoundered an error, so changed collections to use the dict method until that gets fixed:
  • in Usage, use conformance class enum variants instead of strings

PR Checklist:

  • Code is formatted
  • Tests pass
  • Changes are added to the CHANGELOG

@gadomski gadomski self-requested a review April 19, 2025 12:58
Copy link
Copy Markdown
Member

@gadomski gadomski left a comment

Choose a reason for hiding this comment

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

I've been putting off this much needed doc refresh because I'd like to switch to markdown (#785). No objections to this cleanup, but I want to make sure you don't put too much effort into the restructured text docs?

Comment thread README.md Outdated
@philvarner
Copy link
Copy Markdown
Collaborator Author

I've been putting off this much needed doc refresh because I'd like to switch to markdown (#785). No objections to this cleanup, but I want to make sure you don't put too much effort into the restructured text docs?

Noted! I mostly wanted to make sure the content of Quickstart and Usage worked and were accurate -- for example, in Quickstart, running collection search against earthsearch won't work.

Comment thread docs/index.rst Outdated
Comment thread docs/usage.rst Outdated
Comment thread docs/quickstart.rst Outdated
@gadomski gadomski merged commit 14e87fd into main Apr 25, 2025
14 checks passed
@gadomski gadomski deleted the pv/docs branch April 25, 2025 12:29
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.

3 participants