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

docs: general updates for v0.3.0 #122

Merged
merged 12 commits into from Jan 25, 2022

Conversation

LeeDongGeon1996
Copy link
Member

@LeeDongGeon1996 LeeDongGeon1996 commented Jan 20, 2022

Description

  • Update docs.

Checklist

  • My code follows the existing style, code structure, and naming taxonomy
  • I have commented my code, particularly in hard-to-understand areas
  • I have performed a self-review of my own code and included any verifying manual calculations
  • I have added or updated unit tests that prove my fix is effective or that my feature works, and achieves sufficient code coverage. New and existing unit tests pass locally and in the build (below) with my changes
  • My changes generate no new warnings and running code analysis does not produce any issues
  • I have added or run the performance tests that depict optimal execution times
  • I have made corresponding changes to the documentation

@LeeDongGeon1996
Copy link
Member Author

LeeDongGeon1996 commented Jan 20, 2022

@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?

@DaveSkender
Copy link
Member

DaveSkender commented Jan 20, 2022

@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

@LeeDongGeon1996
Copy link
Member Author

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.

@DaveSkender
Copy link
Member

DaveSkender commented Jan 24, 2022

So, I did something in core v1.21.0 that's going to blowup your build. I basically removed all the BadQuotesException cases in the library, so you'd not need to test for that anymore (and can remove those tests).

@LeeDongGeon1996 LeeDongGeon1996 marked this pull request as ready for review January 24, 2022 05:43
@LeeDongGeon1996 LeeDongGeon1996 merged commit 27ff330 into facioquo:main Jan 25, 2022
@LeeDongGeon1996 LeeDongGeon1996 deleted the docs/update-docs branch January 25, 2022 01:23
@github-actions
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 24, 2022
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.

None yet

2 participants