Skip to content

Conversation

@ping-e84
Copy link
Collaborator

Summary:

After much discussion, given the relative simplicity of the project scaffolding, we decided on a more straightforward and maintainable approach to bootstrapping: create an examples/ sub-directory where a fully functional STAC task project will live that users can easily copy and go straight to work on. This has the added benefit of (in essence) documenting the best practices for a STAC task configuration (and is more maintainable than a template). An AI prompt is provided for the user to make the necessary changes to the task for renaming, etc.

Related Issue(s):

Proposed Changes:

  1. add an example / template for users inexperienced with building a STAC task
  2. add user-oriented documentation to reduce the ramp-up time
  3. enhance the readthedocs docs (https://stac-task.readthedocs.io/en/latest/index.html)

PR Checklist:

  • I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.
  • I have reviewed the README and made any necessary changes to keep documentation up-to-date
  • I have reviewed the docs and made any necessary changes to keep documentation up-to-date

Use of AI:

  • Copilot was used to generate initial documentation text
  • all documentation was human-reviewed and edited

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.

1 participant