From f257bd4be2728e49ca5baeb545e757da7de18a2d Mon Sep 17 00:00:00 2001 From: Sebastian Urchs Date: Fri, 10 Nov 2023 16:57:25 -0500 Subject: [PATCH] [DOC] Add link to docs (#624) * Add link to docs * Update README.md Co-authored-by: Alyssa Dai --------- Co-authored-by: Alyssa Dai --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3439c3cc..c1d5b5a0 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,14 @@
-[Neurobagel's](https://www.neurobagel.org/) annotation tool takes BID-style [phenotypic data](https://github.com/neurobagel/annotation_tool/blob/main/cypress/fixtures/examples/good/ds003653_participant.tsv) and [corresponding data description files](https://github.com/neurobagel/annotation_tool/blob/main/cypress/fixtures/examples/good/ds003653_participant.json) and gives users the ability to annotate their data using the Neurobagel data model for preparation to inject that modeled data into Neurobagel's graph database for [federated querying](https://github.com/neurobagel/query-tool). +[Neurobagel's](https://www.neurobagel.org/) annotation tool takes BIDS-style [phenotypic data](https://github.com/neurobagel/annotation_tool/blob/main/cypress/fixtures/examples/good/ds003653_participant.tsv) and [corresponding data description files](https://github.com/neurobagel/annotation_tool/blob/main/cypress/fixtures/examples/good/ds003653_participant.json) and gives users the ability to annotate their data using the Neurobagel data model for preparation to inject that modeled data into Neurobagel's graph database for [federated querying](https://github.com/neurobagel/query-tool). The annotation tool is a Vue application, developed in [JavaScript](https://www.javascript.com/) using a variety of tools including [Nuxt](https://nuxtjs.org/), [Cypress](https://www.cypress.io/), and [BootstrapVue](https://bootstrap-vue.org/docs). +Please refer to our [**official documentation**](https://neurobagel.org/annotation_tool/) for more information on how to use the annotation tool. + [Quickstart](#quickstart) | +[Documentation](https://neurobagel.org/annotation_tool/) | [Local Installation](#local-installation) | [Workflow](#annotation-workflow) | [Navigation](#general-navigation) |