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

Better user docs #68

Merged
merged 3 commits into from
Nov 23, 2022
Merged

Better user docs #68

merged 3 commits into from
Nov 23, 2022

Conversation

jcbhmr
Copy link
Contributor

@jcbhmr jcbhmr commented Nov 22, 2022

👋 Hello! I'm opening this PR to improve the documentation for the user when they visit this repo. Right now it doesn't look to great if you don't know what this repo is about.

This PR would...

  1. Add 2 sections to README.md
  2. Add a header image to README.md
  3. Add a CONTRIBUTING.md since it is highlighted that this project is looking for contributors

Side-by-side screenshot of the README:

Before After

Todo yet:

  • Add documentation about how to add a new feature

@danielbraun89 danielbraun89 merged commit 26826f3 into devcontainers-contrib:main Nov 23, 2022
@danielbraun89
Copy link
Member

This looks awesome 😃 much more professional looking and also inviting to newcommers

@jcbhmr
Copy link
Contributor Author

jcbhmr commented Nov 23, 2022

Awesome! In the future, I hope to improve the docs/guide to add a new feature too.

@jcbhmr jcbhmr deleted the better-user-docs branch November 23, 2022 20:11
@danielbraun89
Copy link
Member

I think that even the docs that you had under "Usage" section here devcontainers-contrib/cookiecutter-devcontainers-feature#1 is already much better than the lame readme I have it now (lets say docs is not exactly my forte 😛 ) so in meantime I might as well copy it into the cookiecutter readme?

also maybe it will be more accessible if it will be the same readme as the main features repo ? under contribution perhaps? ill try to find time handling it tomorrow

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.

None yet

2 participants