-
Notifications
You must be signed in to change notification settings - Fork 321
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
Remove README from docs #503
Conversation
Codecov Report
@@ Coverage Diff @@
## master #503 +/- ##
==========================================
- Coverage 79.58% 79.04% -0.54%
==========================================
Files 102 102
Lines 5921 5912 -9
==========================================
- Hits 4712 4673 -39
- Misses 1209 1239 +30
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
I would keep it and just remove all badges? |
@Borda As far as I confirmed, Introduction Guide already has most of the content in readme. Would you still think it's better to keep readme in the docs? |
@akihironitta mind check failing tests? |
What does this PR do?
This is also a suggestion to remove readme from the docs. I believe no one really sees this ugly readme (as shown in below image) on the docs... Also, readme is not linked from anywhere on the docs, so I'm sure anyone doen't look at this readme page...
https://pytorch-lightning-bolts.readthedocs.io/en/latest/readme.html
Before submitting
PR review
Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
Did you have fun?
Make sure you had fun coding 🙃