Skip to content

Draft: Documentation for ROCrateConverter

I. Nüske requested to merge f-rocrate-documentation into dev

Summary

Added documentation for ROCrateConverter, ELNFileConverter, and ROCrateEntityConverter
Addresses https://gitlab.indiscale.com/caosdb/customers/f-fit/management/-/issues/50

Focus

Is this understandable? Is there important information missing?

Check List for the Author

  • All automated tests pass
  • Reference related issues
  • Up-to-date CHANGELOG.md (or not necessary)
  • Up-to-date JSON schema (or not necessary)
  • Appropriate user and developer documentation (or not necessary)
  • Annotations in code (Gitlab comments)

Check List for the Reviewer

  • I understand the intent of this MR
  • All automated tests pass
  • Up-to-date CHANGELOG.md (or not necessary)
  • Appropriate user and developer documentation (or not necessary)
  • The test environment setup works and the intended behavior is reproducible in the test environment
  • In-code documentation and comments are up-to-date.
  • Check: Are there specifications? Are they satisfied?

Merge request reports