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: general updates for v0.3.0 #122
docs: general updates for v0.3.0 #122
Conversation
9d7f57f
to
6788d28
Compare
@DaveSkender I'm thinking of adding some more infos in README.md because it's a landing page that can give first impression to visitors. It would be more attractive if they can see how to install and simple usage on README even though it is duplicated with GUIDE.md. I'm asking you because you removed them before intentionally. How do you think? |
Yah, I have a bit of that on the .NET one, mostly to show how simple the interface is. Though, I do treat the webpage Home Screen differently than the repo README.Md, mostly because that repo readme gets thrown over to the package site and I want users to go over to the website for a better experience. I also didn’t want them to be redundant. Overall I’d recommend keeping the repo README simpler, but if you want to add a couple more elements, go for it, just make sure it will look nice when getting transposed to PyPI |
I've changed my mind not to change readme. but what I'm thinking is that the better way to get users go to 'Getting started' at a glance. For now, I don't have any idea, so let's just keep as it is. |
So, I did something in core v1.21.0 that's going to blowup your build. I basically removed all the |
b1cfc4e
to
76614cf
Compare
This Pull Request has been automatically locked since there has not been any recent activity after it was closed. Please open a new Issue for related bugs. |
Description
Checklist