Skip to content

Create docs/ README.md #46

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 2 commits into from
Jun 24, 2019
Merged

Create docs/ README.md #46

merged 2 commits into from
Jun 24, 2019

Conversation

grant
Copy link
Contributor

@grant grant commented Jun 24, 2019

Empty for now.

See #40 (comment).

@grant grant changed the title Create README.md Create docs/ README.md Jun 24, 2019
@grant grant requested a review from ace-n June 24, 2019 16:23
Copy link
Contributor

@stew-r stew-r left a comment

Choose a reason for hiding this comment

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

Thanks for starting this! I wasn't sure how to edit the PR directly from the GitHub UI. A few thoughts:

  • Can we highlight that PRs are encouraged and that these are community-maintained? (e.g., just mention it in the title or as a call-out in body)
  • Can we include the debug instructions that have been requested via Issues a few times?
  • Let's link to hear from the main README so that people can find the doc

Copy link

@ace-n ace-n left a comment

Choose a reason for hiding this comment

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

LGTM as-is. @stew-r I figure we can expand on these later?

@grant grant merged commit c24fd70 into master Jun 24, 2019
@grant grant deleted the grant-docs branch June 24, 2019 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants