Merge pull request #25 from NFDI4Chem/development

Development

Author: NRayya

docs/michi/intro.md

@@ -3,5 +3,12 @@ sidebar_position: 1
 ---
 
 # Introduction
+In NFDI4Chem, we provide reporting guidelines, which we refer to as MIChIs (Minimum Information about Chemical Investigation), to cover the chemical investigations in various fields of chemistry. 
 
-Here you can find all the MIChI that are still in the draft phase along with published ones.
+Our initial purpose was, as most MIs do, to support reproducibility in the field. However, being a digitization initiative, we expanded our goals to cover domain-specific findability along with interoperability and knowledge building. When we draft our guidelines, we keep the following questions in mind:
+- What metadata does the researcher need to reproduce the experiment?
+- What metadata would a data analyst look for in a search service? 
+- What domain-prominent controlled vocabulary can be used to provide the best description of the metadata?
+- What high-level controlled vocabulary can be used to provide the best interoperability with the rest of the guidelines and help connect research from different fields to build knowledge?
+
+Fulfilling these requirements renders our guidelines rather strict. While we understand the difficulty in validating a present-day dataset against our guidelines, we keep in mind that guidelines are about how things are supposed to be and not about how they currently are. One of the purposes of our MIChIs is to fill the gap of metadata in the data files generated from the different techniques by leveraging electronic lab notebooks (ELNs) and repositories to request these metadata directly from the user, meaning that a more realistic approach for validating against our MIChIs would include, in addition to the analysis datasets, a "metadata" file complying with the MIChI. We recommend that repositories provide this combination as a package.

docs/michi/nmr/v1/table.md

@@ -141,8 +141,7 @@ Level 2: Recommended. Can be identified by cardinality starting from 0 and by by
     <td>Acquisition Nucleus</td>
     <td>nfdi.nmr.acquisition.nucleus</td>
     <td><a href="https://terminology.nfdi4chem.de/ts/ontologies/nmrcv/terms?iri=http%3A%2F%2FnmrML.org%2FnmrCV%23NMR%3A1400083" style={{ textDecoration: 'underline'}}>Acquisition Nucleus (NMR:1400083)</a></td>
-    <td><b>The nuclei of atoms</b> identified by ChEBI IDs that are leaves of the ontology term <a href="https://terminology.nfdi4chem.de/ts/ontologies/chebi/terms?iri=http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FCHEBI_33250&obsoletes=false" style={{ textDecoration: 'underline'}}>atom (CHEBI:33250)</a>
-    </td>
+    <td><b>The nuclei of atoms</b> identified by ChEBI IDs that are leaves of the ontology term <a href="https://terminology.nfdi4chem.de/ts/ontologies/chebi/terms?iri=http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FCHEBI_33250&obsoletes=false" style={{ textDecoration: 'underline'}}>atom (CHEBI:33250)</a></td>
     <td style={{ whiteSpace: 'nowrap'}}>1-d</td>
     <td>13C</td>
     <td>The nucleus of <a href="https://terminology.nfdi4chem.de/ts/ontologies/chebi/terms?iri=http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FCHEBI_36928&obsoletes=false" style={{ textDecoration: 'underline'}}>CHEBI:36928</a></td>

docusaurus.config.js

@@ -1,15 +1,16 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const { themes } = require('prism-react-renderer');
+const lightCodeTheme = themes.github;
+const darkCodeTheme = themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
   title: 'Minimum Information Requirements',
   tagline: 'NFDI4Chem Workshop Series' ,
-  url: 'https://github.com/NFDI4Chem/workshops',
-  baseUrl: '/workshops/',
+  url: 'https://github.com',
+  baseUrl: '/NFDI4Chem/workshops/',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/logo.png',