From b86c8bbabcd2fbe846d36a30f2182a6ab1fba8b3 Mon Sep 17 00:00:00 2001 From: sczakihl <94172011+sczakihl@users.noreply.github.com> Date: Fri, 2 Feb 2024 08:00:16 +0100 Subject: [PATCH] docs: adding introduction section to section Quickstart (#410) Co-authored-by: Manuel Holtgrewe --- docs/doc_quickstart.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/doc_quickstart.rst b/docs/doc_quickstart.rst index efe4b30b..32ec7e4d 100644 --- a/docs/doc_quickstart.rst +++ b/docs/doc_quickstart.rst @@ -4,10 +4,23 @@ Quickstart ========== -Do you like to jump heads-first into the water? Then this is the place for you! +Do you like to jump heads-first into the water? +Then this is the place for you! For a more in-depth explanation of REEV, see the :ref:`tutorial `. However, REEV also contains helpful help links throughout the web interface so you can also look up information as you go. +.. _doc_quickstart_introduction: + +------------ +Introduction +------------ + +We have developed REEV (Review, Evaluate and Explain Variants) to help clinicians and researchers in rare disease genetics with an open and free platform to explore comprehensive information about genes as well as sequence and structural variants. +REEV is designed to help you to quickly yet comprehensively record all the important information on a variant and, on the basis of this, to evaluate it on the basis of the ACMG criteria. +To this end, REEV also integrates methods that allow users to (semi-)automatically fill the individual ACMG criteria sections to facilitate interpretation. + +Here, we provide a quick start as well as a full tutorial guiding you through the process on reviewing and evaluating genes and variants with the help of REEV. + .. _doc_quickstart_home: ---------