Main page documentation update #119
Merged
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
Codecov Report
@@ Coverage Diff @@
## master #119 +/- ##
=========================================
Coverage 96.64% 96.64%
Complexity 1057 1057
=========================================
Files 156 156
Lines 2505 2505
Branches 230 230
=========================================
Hits 2421 2421
Misses 31 31
Partials 53 53 Continue to review full report at Codecov.
|
jzrilic
reviewed
Jul 19, 2022
jzrilic
reviewed
Jul 20, 2022
0e63b48 to
ef0e88c
Compare
jzrilic
reviewed
Jul 21, 2022
Change and reformat short module descriptions and link each module header to the corresponding module README.md so the documentation is more concise, understandable and easier to navigate
ef0e88c to
1084ca7
Compare
jzrilic
approved these changes
Jul 21, 2022
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.
Basic information
1.4.1
nrich
Additional information
Description
Summary
Changed module's short descriptions and linked each header to correct module's README.md.
Details
Reformatted, changed or reworded short descriptions of every module except
nrich-validation. Linked every header to correct module README.md for easier navigation in documentation.Related issue
Types of changes
Checklist
I have checked my code with the project's static analysis tooling(not required as I did not change any code)I have formatted my code with the project's IDEA code-style configuration(not required as I did not change any code)I have checked my code for misspellings(not required as I did not change any code)My change requires a change to the documentation(not required as I did not change any code)I have added tests to cover my changes(not required as I did not change any code)All new and existing tests pass.(not required as I did not change any code)