Skip to content

Modify readthedocs to be "Recipes-first" #222

@brendanreardon

Description

@brendanreardon

Feature description

Our ReadtheDocs should enable new users to quickly generate their own Categorical Variant objects based on a Recipe that is helpful to them, without needing to read lots of documentation.

It should begin with simple use cases of common genomic variant representation, and direct users for how to create and validate Cat-VRS objects for those use cases. These should be Recipe-first in their approach. To that end, outputs would be to have a Quick Start for:

  • Canonical Alleles
  • Protein Sequence Consequences
  • Categorical Copy Number alterations
  • Gene Fusions

Bonus points:

This was originally posted as a Hackathon idea for the 2026 Connect Hackathon

Contribution

Yes, I can create a PR for this feature.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions