Cleanup readmes #5263
Merged
Cleanup readmes #5263
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jack-berg
force-pushed
the
cleanup-readmes
branch
from
a8ae21d to
c8e72be
Compare
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## main #5263 +/- ##
============================================
- Coverage 91.07% 91.05% -0.03%
+ Complexity 4881 4880 -1
============================================
Files 549 549
Lines 14428 14428
Branches 1374 1374
============================================
- Hits 13141 13138 -3
- Misses 892 893 +1
- Partials 395 397 +2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
jkwatson
approved these changes
Mar 4, 2023
mateuszrzeszutek
approved these changes
Mar 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I occasionally come across situations where readmes are wrong or out of date. In almost all cases, the readmes simply contain links to the javadoc.
I propose we move those javadoc links to the artifact tables in the root README, and only keep READMEs around if they contain useful information not already available in the root README.