search

Project-MONAI / monai-deploy

MONAI Deploy aims to become the de-facto standard for developing, packaging, testing, deploying and running medical AI applications in clinical production.
Apache License 2.0
97 stars 22 forks source link

guidelines: Workloads #35

Closed whoisj closed 3 years ago

whoisj commented 3 years ago

This change fixes up several issues with the existing workloads document. The goal is to make the document as professional as possible.

  1. Corrects a merge conflict which was left in the document from a previous PR.
  2. Corrects several spelling mistakes.
  3. Adds descriptive alternative text to images for visually impaired readers (or jus those using a screen reader)
  4. Added an table of contents
    • This replaces the previous text of "[TOC]" which did not actually serve as a table of contents
  5. Corrects the formatting of all tables.
    • Adjust column widths
    • Adjust column alignments
    • Correct whitespace for better text wrapping
  6. Renames files using all lowercase letters.
    • Standardizes word spacing by replacing a mix of no space, underscore, and camel casing with hyphens.
  7. Removes non-standard "{#anchor-name}" tags on all header items.
    • The original text was clearly attempting to provide anchor tags, but actually just ended up corrupting the existing tags. example: ### Goal {#goal} became #goal-goal instead of the desired #goal.
  8. Fixes several markdown errors which were causing minor page layout issues when viewed on github.com.