Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

Improve README and repo onboarding #114

Merged
merged 6 commits into from
Aug 28, 2018

Conversation

Mr0grog
Copy link
Collaborator

@Mr0grog Mr0grog commented Aug 24, 2018

This is a general cleanup of the readme to help make sure this repo is in a clear and understandable state as I’m on my way out:

  • Fix a bunch of links and typos
  • Make contribution instructions more inviting
  • Describe what concept docs should cover
  • Add a lot more links and info on roadmaps, research, and contributions
  • Fix out-of-date install instructions

I am also closing #52, which contains a summary of the research that kicked off my work on the docs here. It’s useful information, but it’s not actionable and its presence in the issue queue is noise. It and the full research output are now linked from the README and from the user-research repo so people can still find them.

License: MIT
Signed-off-by: Rob Brackett <[email protected]>
License: MIT
Signed-off-by: Rob Brackett <[email protected]>
License: MIT
Signed-off-by: Rob Brackett <[email protected]>
License: MIT
Signed-off-by: Rob Brackett <[email protected]>
Make the language a little more inviting, add links to the contributing guide and code of conduct.

License: MIT
Signed-off-by: Rob Brackett <[email protected]>
We made Hugo auto install a while back to fix problems on our CI servers.

Fixes #79.

License: MIT
Signed-off-by: Rob Brackett <[email protected]>
Copy link
Contributor

@meiqimichelle meiqimichelle left a comment

Choose a reason for hiding this comment

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

🚢

@meiqimichelle meiqimichelle merged commit 12dbd05 into master Aug 28, 2018
@meiqimichelle meiqimichelle deleted the docs/improve-repo-onboarding branch August 28, 2018 05:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants