Merge pull request #394 from NeurodataWithoutBorders/update_doc_page

Update Documentation and Contact Us pages
NeurodataWithoutBorders · Sep 27, 2023 · 3de0173 · 3de0173
2 parents 4c4605e + 65ad1cf
commit 3de0173
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 24 deletions.
diff --git a/src/renderer/assets/css/main.css b/src/renderer/assets/css/main.css
@@ -1663,14 +1663,6 @@ details[open] > summary::before {
     .front-page_logo {
         width: 80rem;
     }
-
-    .document-content {
-        height: 55% !important;
-    }
-
-    .docu_divide {
-        margin-bottom: 10rem !important;
-    }
 }
 
 .overview_lottie_header {
@@ -1749,7 +1741,7 @@ details[open] > summary::before {
     align-items: center;
     flex-direction: column;
     width: 100%;
-    height: 57%;
+    height: 40%;
     display: flex;
     justify-content: center;
 }
@@ -1761,6 +1753,7 @@ details[open] > summary::before {
 }
 
 .docu-content-container {
+    padding-top: 1rem;
     margin-bottom: 1rem;
     display: flex;
     flex-direction: column;

diff --git a/src/renderer/src/stories/pages/contact-us/Contact.js b/src/renderer/src/stories/pages/contact-us/Contact.js
@@ -28,13 +28,13 @@ export class ContactPage extends Page {
                                 </div>
                                 <div class="docu-content-container">
                                     <h2 class="document_text">
-                                        If you have any issue or suggestions, please email us at
+                                        If you encounter any issues or have requests for new features, please create a
+                                        new
                                         <a
-                                            style="text-decoration: underline"
                                             target="_blank"
-                                            href="mailto:[email protected]"
-                                            >[email protected]</a
-                                        >
+                                            href="https://github.com/NeurodataWithoutBorders/nwb-guide/issues/new/choose"
+                                            >ticket on our GitHub page</a
+                                        >.
                                     </h2>
                                 </div>
                             </div>

diff --git a/src/renderer/src/stories/pages/documentation/Documentation.js b/src/renderer/src/stories/pages/documentation/Documentation.js
@@ -24,28 +24,63 @@ export class DocumentationPage extends Page {
                             <div class="dc_con">
                                 <h1 class="doc_header">Documentation</h1>
                                 <hr class="docu_divide" />
-                                <div class="document-content" style="justify-content: center">
+                                <div class="document-content">
                                     <div id="documentation-lottie" class="documentation-lottie_style"></div>
                                 </div>
                                 <div class="docu-content-container">
-                                    <h2 class="document_text">
-                                        We have created a documentation page for each feature in SODA. You can find the
-                                        documentation site by clicking on the button below:
-                                    </h2>
+                                    <h2 class="document_text">Documentation for NWB GUIDE is in development.</h2>
+                                    <p>
+                                        Conversion to NWB is powered by
+                                        <a target="_blank" href="https://neuroconv.readthedocs.io/">NeuroConv</a>.
+                                    </p>
+                                    <p>
+                                        Inspection of NWB files is powered by
+                                        <a target="_blank" href="https://nwbinspector.readthedocs.io/">NWB Inspector</a
+                                        >.
+                                    </p>
+                                    <p>
+                                        <a target="_blank" href="https://github.com/flatironinstitute/neurosift"
+                                            >Neurosift</a
+                                        >
+                                        is an interactive data visualization tool created by Jeremy Magland at the
+                                        Flatiron Institute.
+                                    </p>
+                                    <p>
+                                        For help on creating a Dandiset and uploading to DANDI, please see the
+                                        <a target="_blank" href="https://www.dandiarchive.org/handbook/13_upload/"
+                                            >DANDI Documentation</a
+                                        >.
+                                    </p>
+                                    <p>
+                                        To learn more about NWB, please see the
+                                        <a target="_blank" href="https://nwb-overview.readthedocs.io/"
+                                            >NWB Overview Documentation</a
+                                        >.
+                                    </p>
+
+                                    <p>
+                                        NWB GUIDE is an open-source project developed by CatalystNeuro (Cody Baker,
+                                        Garrett Flynn, Ben Dichter) and Lawrence Berkeley National Laboratory (Ryan Ly,
+                                        Oliver Ruebel) and generously supported by
+                                        <a target="_blank" href="https://www.kavlifoundation.org/"
+                                            >The Kavli Foundation</a
+                                        >.
+                                    </p>
+
+                                    <!--
                                     <div class="button_container_contact">
                                         <button
                                             id="doc-btn"
                                             class="view_doc_button sodaVideo-button"
                                             style="margin-top: 1rem"
                                             @click="${() => {
-                                                window.open(
-                                                    "https://docs.sodaforsparc.io/docs/getting-started/organize-and-submit-sparc-datasets-with-soda"
-                                                );
-                                            }}"
+                                        window.open("https://neuroconv.readthedocs.io/en/main/");
+                                    }}"
                                         >
-                                            View the Documentation
+                                            View the NeuroConv Documentation
                                         </button>
                                     </div>
+                                    -->
                                 </div>
                             </div>
                         </div>