Skip to content

Multiple Documentation Updates #313

Open
@jjacobson95

Description

@jjacobson95

The Documentation site needs a bit more fine tuning.

  • In-line code blocks are overlapping each other. We can either adjust the code block padding or add more space between lines of text.
  • Check for typos (not sure how many are present but I've noticed few so far - "trining", "respones", "referr", "sucessfully", etc)
  • Mention use case for each split_type. I think a bit more context could be helpful for users. Maybe even add a table for further explanation.
  • Check that all in-page links work. Additionally make sure that they bring you to the write place, currently the header is not calculated into where the page should refocus at.
  • More explanation for thresh, num_classes, quantiles usages.
  • This can be put in a different issue, but we should discuss what we information we want for each of the datasets - currently this still has broad_sanger as a single dataset.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    Status

    No status

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions