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

docs: improve readme #418

Merged
merged 1 commit into from
Feb 20, 2023
Merged

Conversation

AntoineRR
Copy link
Collaborator

Description

This is a proposal for a new readme with updated information.
Also the readme was duplicated in the docs folder. I kept only the one in the docs folder as it should appear on the repo homepage too as stated in this documentation. This will make us maintain only one readme instead of trying to keep both in sync.

@netlify
Copy link

netlify bot commented Feb 17, 2023

Deploy Preview for robyn canceled.

Name Link
🔨 Latest commit a047076
🔍 Latest deploy log https://app.netlify.com/sites/robyn/deploys/63f2a8db902d3100082170fa

docs/README.md Outdated Show resolved Hide resolved
Copy link
Member

@sansyrox sansyrox left a comment

Choose a reason for hiding this comment

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

All looks great! But, would this not replace the README preview on the main GitHub preview?

@AntoineRR
Copy link
Collaborator Author

The docs/README.md file should indeed appear as a preview on the repo main page.
I've been thinking about this though, and wonder if we shouldn't have a completely different README.md for the docs (that will appear in the home page of the docs)? Not sure it makes sense to have the readme both in the repo and on the docs home page

@sansyrox
Copy link
Member

I've been thinking about this though, and wonder if we shouldn't have a completely different README.md for the docs (that will appear in the home page of the docs)?

We can do that but what will be different in both of them?

@AntoineRR AntoineRR force-pushed the readme-improvements branch 2 times, most recently from c80ba80 to f4cb518 Compare February 19, 2023 22:05
@AntoineRR
Copy link
Collaborator Author

I updated the docs/README.md with a more documentation centered approach, LMK if that suits you.
Also added the Robyn logo as the docs website icon!

@AntoineRR AntoineRR requested a review from sansyrox February 19, 2023 22:07
docs/README.md Outdated Show resolved Hide resolved
Copy link
Member

@sansyrox sansyrox left a comment

Choose a reason for hiding this comment

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

Great work @AntoineRR . LGTM! 👍

@sansyrox sansyrox merged commit 646e529 into sparckles:main Feb 20, 2023
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