NDIP - Documentation

[mpatrou]

Description of Changes:

This includes information per page about functionality, fields, input validation and contains links to the associated wireframes:

• Home Page
• Reduction Plan
• Normalization
• Integration

The information is focused on the client-side, while some information about the server-side is provided.

Related Items

To Test:

cd /path/to/my/local/garnet/repo/
git fetch origin pull/<PULL_REQUEST_NUMBER>/head:pr<PULL_REQUEST_NUMBER>
git switch pr<PULL_REQUEST_NUMBER>
conda activate <garnet_environment>
python -m pytest <item_to_test>

Check list for the pull request

• I have read the [CONTRIBUTING]
• I have read the [CODE_OF_CONDUCT]
• I have added tests for my changes
• I have updated the documentation accordingly

---

Check list for the reviewer

• I have read the [CONTRIBUTING]
• I have verified the proposed changes
• best software practices
  • all internal functions have an underbar, as is python standard
  • clearly named variables (better to be verbose in variable names)
  • code comments explaining the intent of code blocks
• All the tests are passing
• The documentation is up to date
• code comments added when explaining intent

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8adfd88) to head (0ffb669).
Report is 2 commits behind head on next.

Additional details and impacted files

@@            Coverage Diff            @@
##              next       #29   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        13           
  Lines          236       236           
=========================================
  Hits           236       236           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[zjmorgan]

Looks good!

[marshallmcdonnell]

Overall, LGTM!

My comments above are only suggestions, feel free to disregard.