WIP: started fleshing out the reader docs.

neurolibre · Jul 21, 2024 · 6107fa4 · 6107fa4
1 parent 924fd1a
commit 6107fa4
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 9 deletions.
diff --git a/source/ARTICLE.rst b/source/ARTICLE.rst
@@ -0,0 +1,18 @@
+Article page
+============
+
+The first thing you will notice on a neurolibre living article page is a pdf summary of the article. This pdf is really simply a summary of the work.
+
+Then next to it, you will find a series of links. These links are proper archives of all the necessary assets required to reproduce the article. This includes the data, the original code repository, the docker container with all the environment, as well as the thread with the technical screening of the living article.
+
+.. image:: img/reader_assets.png
+  :width: 400
+  :alt: Links to reproducibility assets
+
+Each asset has its own DOI, which is linked to the DOI of the living article. That DOI, along with a citation (available in plain text and bib format) are also available.
+
+.. image:: img/reader_citation.png
+  :width: 400
+  :alt: Citation to a neurolibre living article.
+
+A badge with the DOI is available to insert on a github repo or a webpage.
diff --git a/source/READER.rst b/source/READER.rst
diff --git a/source/REPRODUCIBLE.rst b/source/REPRODUCIBLE.rst
@@ -0,0 +1,12 @@
+Reproducible article
+====================
+
+This is the core content of the NeuroLibre living article: a static webpage, which may include interactive figures or dashboards.
+
+DESCRIBE INTERACTIVE FIGURES
+
+DESCRIBE CODE BLOCKS
+
+DESCRIBE CITATIONS
+
+LINK TO JUPYTER BOOKS FOR MORE INFO
diff --git a/source/img/reader_assets.png b/source/img/reader_assets.png
diff --git a/source/img/reader_citation.png b/source/img/reader_citation.png
diff --git a/source/index.rst b/source/index.rst
@@ -12,7 +12,7 @@
    :maxdepth: 2
    :caption: Reader
 
-   READER
+   ARTICLE
 
 .. toctree::
    :maxdepth: 2
@@ -35,4 +35,4 @@
    :maxdepth: 2
    :caption: FAQ
 
-   FAQ
+   FAQ