Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: started fleshing out the reader docs. #50

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions source/ARTICLE.rst
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 0 additions & 7 deletions source/READER.rst

This file was deleted.

12 changes: 12 additions & 0 deletions source/REPRODUCIBLE.rst
Original file line number Diff line number Diff line change
@@ -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
Binary file added source/img/reader_assets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/img/reader_citation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
:maxdepth: 2
:caption: Reader

READER
ARTICLE

.. toctree::
:maxdepth: 2
Expand All @@ -35,4 +35,4 @@
:maxdepth: 2
:caption: FAQ

FAQ
FAQ
Loading