sequencescape icon indicating copy to clipboard operation
sequencescape copied to clipboard

Y24-283 - Update Yard documentation to include proper descriptions for resources

Open dasunpubudumal opened this issue 5 months ago • 0 comments

User story As developers, we need to update Yard documentation hosted at https://sanger.github.io/sequencescape/ to include proper overview sections for resources in Api::V2

Who are the primary contacts for this story Dasun, Steve, Katy, Abdullah, Stephen H

Who is the nominated tester for UAT

Acceptance criteria To be considered successful the solution must allow:

  • [ ] Add a detailed description on what each resource represents. This needs to include the business value of that resource.
  • [ ] Add any example usage of API or cURL

Dependencies This story is blocked by the following dependencies:

References This story has a non-blocking relationship with:

Additional context Add any other context or screenshots about the feature request here.

dasunpubudumal avatar Aug 28 '24 09:08 dasunpubudumal