From fbdc98abf76a4602f021992575405f95fcb45c35 Mon Sep 17 00:00:00 2001 From: Shannon Young Date: Wed, 27 Sep 2023 20:48:45 -0700 Subject: [PATCH] Fix README urls --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index de87c1b..8dbaa40 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # mobile-client-json +[1]: "AssessmentModelKMM" +[2]: "Surveys_ResearcherUI" +[3]: "AssessmentConfig" + Json Schema Draft 7 documentation for the JSON model objects used to build the iOS and Android Assessment Models. The [AssessmentModel][1] library used by all internally developed assessments considers an assessment to be any measurement, including surveys, that can be run on a mobile @@ -7,10 +11,7 @@ device, provided that the library dependencies for a given app are set up to inc This repoitory includes the schemas used to define: - [Result Archives](#result-archives): The output files for a single run of an assessment. -- [Building a Survey](#building-a-survey): The [AssessmentConfig][2] for describing all the questions and branching logic for running a survey. - -[1]: "AssessmentModelKMM" -[2]: "AssessmentConfig" +- [Building a Survey](#building-a-survey): The [AssessmentConfig][3] for describing all the questions and branching logic for running a survey. ## Result Archives @@ -62,8 +63,6 @@ Each element in the survey is a `Node` where the root-level `Node` must also be The [AssessmentModel][1] library has only one "type" key defined for an `Assessment`, but this key must be included in the JSON or the serialization will fail. -[1]: "AssessmentModelKMM" - - Note: The terms "node" and "step" are used interchangably within this document and essentially mean the same thing. This is for historical reasons wherein assessments are designed to conform to both the language/syntax used by older frameworks (namely ResearchKit and ResearchStack) and the concept of a @@ -250,8 +249,6 @@ Currently, instruction steps can be: - [Permission Steps](#permission-steps) - [Completion Step](#completion-step) -[2]: "Surveys_ResearcherUI" - #### Overview Step In the [survey builder designs][2] this is referred to as the "Title Page". This step