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

Form configuration page documentation update #125

Merged
merged 1 commit into from
Aug 18, 2022

Conversation

nkescec
Copy link
Contributor

@nkescec nkescec commented Jul 29, 2022

Basic information

  • nrich version:
    1.4.1
  • Module:
    nrich-form-configuration

Additional information

Description

Summary

Changed documentation for nrich-form-configuration modules so that it contains more examples and is easier to follow.

Details

Documentation that was changed and the changes made:

  • nrich-form-configuration-api -> changed overview
  • nrich-form-configuration-spring-boot-starter -> reformatted and reworded documentation, added missing information
  • nrich-form-configuration -> added examples, explanations, restructured the README.md so that it is easier to follow when reading and searching, added missing information

Related issue

Types of changes

  • Docs change

Checklist

  • I have read the project's CONTRIBUTING document
  • 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)
  • I have organized my changes in easy-to-follow commits
  • My change requires a change to the documentation (not required as I did not change any code)
  • I have updated the documentation accordingly
  • 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)

@nkescec nkescec added the documentation Improvements or additions to documentation label Jul 29, 2022
@codecov
Copy link

codecov bot commented Jul 29, 2022

Codecov Report

Merging #125 (872d834) into master (1c5eb4e) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #125   +/-   ##
=========================================
  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           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@nkescec nkescec force-pushed the feature_updateFormConfigurationDocumentation branch from bfbc2c0 to 6bb2e31 Compare August 1, 2022 06:59
@nkescec nkescec force-pushed the feature_updateFormConfigurationDocumentation branch from 6bb2e31 to 657528e Compare August 17, 2022 11:36
@nkescec nkescec requested a review from agrancaric August 17, 2022 11:37
Change and reformat documentation in nrich-form-configuration/README.md,
nrich-form-configuration-api/README.md and nrich-form-configuration-spring-boot-starter/README.md.
Add example class into nrich-form-configuration/README.md.
Describe custom notification setup and link class mentions to classes
@nkescec nkescec force-pushed the feature_updateFormConfigurationDocumentation branch from 657528e to 872d834 Compare August 18, 2022 09:16
@agrancaric agrancaric merged commit de5c626 into master Aug 18, 2022
@agrancaric agrancaric deleted the feature_updateFormConfigurationDocumentation branch August 18, 2022 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants