Skip to content

Conversation

@xhluca
Copy link

@xhluca xhluca commented Jun 21, 2021

The current readme contains a lot of internal information that might not be useful for most users visiting the repository, and the starting paragraph is a bit hard to understand.

I made those small changes (click here for readme):

  • Rewrite the starting paragraph to be clearer
  • Move up the zip download instructions to be the first thing any user sees
  • Everything else to a "Contributing.md" file

Let me know if those changes make sense!

Closes #633

@xhluca xhluca changed the title Slightly improve readme Refactor Readme and add a contributing doc Jun 22, 2021
@xhluca xhluca requested a review from jdamiba June 22, 2021 19:56
@xhluca
Copy link
Author

xhluca commented Jun 24, 2021

@plotly/marketing @alexcjohnson Any thoughts on this? This will probably be a pretty impactful change since sample apps gets 40k visits per month

Copy link
Collaborator

@alexcjohnson alexcjohnson left a comment

Choose a reason for hiding this comment

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

💃 I like it!

Co-authored-by: Alex Johnson <johnson.alex.c@gmail.com>
@xhluca xhluca merged commit 2bed4b3 into main Jun 28, 2021
@xhluca xhluca deleted the update-readme branch June 28, 2021 22:36
xhluca pushed a commit that referenced this pull request Jul 13, 2021
Refactor Readme and add a contributing doc

Former-commit-id: 2bed4b3
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.

Move "Contributing to the sample apps repo" to a contributing.md

3 participants