Skip to content
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

chore: remake repo main README.md #2016

Closed
wants to merge 3 commits into from
Closed

chore: remake repo main README.md #2016

wants to merge 3 commits into from

Conversation

4F24L
Copy link

@4F24L 4F24L commented Sep 28, 2024

Closes #1809

📑 Description

Key Changes:

  • Improved alignment and structure for better readability.
  • New Recorded GIFs added
  • Enhanced section headers for clarity and accessibility.
  • Incorporated tables for GIFs to organize content visually.
  • Reformatted provider logos for consistency.

Would you like to make any additional tweaks or adjustments to this redesign?

✅ Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

ℹ Additional Information

  • New screen recorded GIFs added.
  • Top contributors list updated.

Copy link

vercel bot commented Sep 28, 2024

@4F24L is attempting to deploy a commit to the KeepHQ Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Sep 28, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
keep ⬜️ Ignored (Inspect) Visit Preview Sep 28, 2024 5:14pm

@talboren
Copy link
Member

Thank you @4F24L! I’ll review it ASAP and suggest further edits

@talboren talboren changed the title feat: remake repo main README.md chore: remake repo main README.md Sep 28, 2024
@4F24L
Copy link
Author

4F24L commented Sep 28, 2024

Excited to see my first PR getting merged.

@talboren
Copy link
Member

@4F24L Thank you so much for this! I have a few points I would like you to address. Besides the "styling" of the page itself, the information is also out dated and doesn't send out the Keep "message" perfectly. I would suggest opening https://www.keephq.dev and trying to align the message there to what we currently have in README. The images are great but some text needs to be adjusted. Would you like to give it another try?

@talboren talboren self-requested a review September 29, 2024 06:52
@4F24L
Copy link
Author

4F24L commented Sep 29, 2024

Okay, I will try to make changes as per your suggestion.

@shahargl
Copy link
Member

@4F24L I'm not sure about this issue, since the README is kinda "Keep's face" and I feel should be made by the core maintainers with the most context of what Keep does.

@shahargl
Copy link
Member

For example, we want to add actual examples and videos/screenshots from the platform.

@4F24L
Copy link
Author

4F24L commented Sep 29, 2024

For example, we want to add actual examples and videos/screenshots from the platform.

I added the actual images and screenshots from the platform. please check that out.

@4F24L
Copy link
Author

4F24L commented Sep 29, 2024

@4F24L Thank you so much for this! I have a few points I would like you to address. Besides the "styling" of the page itself, the information is also out dated and doesn't send out the Keep "message" perfectly. I would suggest opening https://www.keephq.dev and trying to align the message there to what we currently have in README. The images are great but some text needs to be adjusted. Would you like to give it another try?

I checked that website, and I'm confused about that. Should I make changes to the landing page also?? or the data from the website should be updated on the readme file.

@4F24L
Copy link
Author

4F24L commented Sep 29, 2024

I made some little changes.

  • Added landing page screenshot at the top.

review this !

@talboren
Copy link
Member

@4F24L I'm sorry for the confusion on this one. I have just synced with @shahargl and will go ahead to close the issue and PR.
Thank you so much for the effort you put on this! I'll be more than happy to collaborate together on another issue if you will!

@talboren talboren closed this Sep 29, 2024
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.

[📃 Docs]: remake repo main README
3 participants