Skip to content

Readme redesign #381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
May 22, 2025
Merged

Readme redesign #381

merged 18 commits into from
May 22, 2025

Conversation

jonhealy1
Copy link
Collaborator

@jonhealy1 jonhealy1 commented May 21, 2025

Related Issue(s):

  • None

Description:

  • Improved README documentation with consistent formatting and enhanced sections:
    • Added sfeos logo and banner
    • Added a comprehensive Quick Start guide
    • Reorganized sections for better navigation
    • Reformatted content with bullet points for improved readability
    • Added more detailed examples for API interaction

PR Checklist:

  • Code is formatted and linted (run pre-commit run --all-files)
  • Tests pass (run make test)
  • Documentation has been updated to reflect changes, if applicable
  • Changes are added to the changelog

@jonhealy1 jonhealy1 marked this pull request as ready for review May 21, 2025 12:32
@jonhealy1 jonhealy1 requested a review from jamesfisher-geo May 21, 2025 13:28
Copy link
Collaborator

@jamesfisher-geo jamesfisher-geo left a comment

Choose a reason for hiding this comment

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

This is great @jonhealy1! Just a couple things to consider

README.md Outdated

<!-- markdownlint-disable MD033 MD041 -->

<p align="left">
<img src="https://raw.githubusercontent.com/stac-utils/stac-fastapi-elasticsearch-opensearch/refs/heads/main/assets/stac-030-long.png" width=700>
<img src="assets/sfeos-bw.png" width=1200>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is the logo supposed to be aligned to the left? It looks like this for me
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The logo is supposed to be aligned to the left. It's a banner so if it was centered it may be weird on some devices, but I don't know. We could try it centered.

@jonhealy1 jonhealy1 requested a review from jamesfisher-geo May 22, 2025 16:13
Copy link
Collaborator

@jamesfisher-geo jamesfisher-geo left a comment

Choose a reason for hiding this comment

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

Looks good to me

@jonhealy1 jonhealy1 merged commit c43a5f0 into main May 22, 2025
15 checks passed
@jonhealy1 jonhealy1 deleted the readme-redesign branch May 22, 2025 16:28
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