Skip to content

Revise readthedocs to use plain language #140

@brendanreardon

Description

@brendanreardon

From today's meeting, one action item brought up is to simplify language across the readthedocs. The scope of this Issue is purely editorial.

Somewhat relating to #137 create a glossary of terms, some problem areas and concepts are:

  • What is meant by an assayed variant?
  • What is a categorical variant?
  • What is a constraint?
  • What is a recipe?

Before diving into revising each page, we should first assess each page for confusing areas:

  • Introduction
  • How Cat-VRS works
  • Getting Involved
  • Data Model
    • Cat-VRS model
    • Recipes
    • Imported Data Types and Classes
  • Implementation Guide
  • 1.0 (pre-releases)
  • Appendices
    • GKS Maturity Model
    • Design Decisions
    • FAQ

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions