Skip to content

Commit 8f8aa90

Browse files
authored
Refactor documentation (#499)
* Refactor to get started. * Add getting started section. * Add datashuttle examples. * Add example scripts. * More edits to documentation. * More tidying up. * Add TUI to valiate configs. * Add examples. * Fix error in formatting. * Fix wrong filenames in walkthrough. * Some tidy ups, update roadmap. * More tidying up. * Fix small errors. * More small tidy ups. * Final tidy ups for documentation. * Tidy up roadmap. * Remove full stops from cards. * Use only python part of example script. * Move 'choose a terminal' to user guides. * First draft on clearer get-started page. * Link to a python install tutorial. * Link to a python install tutorial. * Fix grammer on lab projects page. * Don't capitalise all words in a title. * Update text align. * Add more details to index page. * Revert changes to .css * rework card slightly * Fix center alignment, for header only. * world file -> filepath. * Add fixed title. * Fix title levels/ * Fix name typo. * Update install python link. * Make validate from path page orphan to supress warning. * Fix broken link.
1 parent e4a7631 commit 8f8aa90

34 files changed

+720
-496
lines changed

docs/source/_static/css/custom.css

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,3 @@ html[data-theme=light] {
4646
height: auto;
4747
margin: 5px auto;
4848
}
49-
50-
.center {
51-
text-align: center;
52-
}
-1.05 MB
Loading
-928 KB
Loading
22.7 KB
Loading
22.5 KB
Loading

docs/source/index.md

Lines changed: 72 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
:html_theme.sidebar_secondary.remove:
22

3-
{.center}
4-
# **datashuttle**
3+
<!-- We want to have a centered title, which is difficult in sphinx without centering
4+
the entire page. We need the title here otherwise the tab title defaults to <no-title>.
5+
Therefore, add the title and hide it, then add a custom centered title.
6+
-->
57

6-
<p style="text-align: center; font-size: 22px;">The tool to automate neuroscience project folder creation, validation and transfer.</p>
8+
```{raw} html
9+
<div style="height: 0; visibility: hidden;">
10+
```
11+
# datashuttle
12+
```{raw} html
13+
</div>
14+
```
15+
16+
<p style="text-align: center; font-size: 48px;"><b>datashuttle</b></p>
17+
<p style="text-align: center; font-size: 22px;">Automate the creation, validation and transfer of neuroscience project folders.</p>
718

819
```{image} _static/datashuttle-overview-light.png
920
:alt: My Logo
@@ -19,53 +30,88 @@
1930
```
2031
<br>
2132

22-
::::{grid} 1 2 2 3
33+
34+
::::{grid} 1 2 2 4
2335
:gutter: 4
2436

25-
:::{grid-item-card} Tutorials
26-
:link: pages/tutorials
37+
38+
:::{grid-item-card} Get started
39+
:link: pages/get_started/index
40+
:link-type: doc
41+
42+
Get started with ``datashuttle``
43+
:::
44+
45+
46+
:::{grid-item-card} User guides
47+
:link: pages/user_guides/index
2748
:link-type: doc
2849

29-
Walkthrough **datashuttle**.
50+
Explore ``datashuttle``'s features
3051
:::
3152

32-
:::{grid-item-card} How To
33-
:link: pages/how_tos
53+
:::{grid-item-card} Examples
54+
:link: pages/examples/index
3455
:link-type: doc
3556

36-
Short guides on specific actions.
57+
``datashuttle`` in the real world
3758
:::
3859

3960
:::{grid-item-card} Python API
4061
:link: pages/api_index
4162
:link-type: doc
4263

43-
Full Python reference.
64+
Full Python reference
4465
:::
45-
::::
4666

47-
**datashuttle** creates and validates projects standardised to the
48-
[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev)
49-
specification.
67+
::::
5068

51-
Dive right into **datashuttle** with our
52-
[Getting Started Tutorial](tutorial-getting-started)
53-
or targeted [How-To Guides](how-tos). \
54-
It can be used through a graphical interface or Python API.
69+
A lack of project standardization in systems neuroscience
70+
[hinders data sharing and collaboration](https://neuroinformatics.dev/blog/neuroblueprint.html),
71+
creating barriers to reproducibility and scientific progress.
72+
73+
``datashuttle`` helps standardise experimental
74+
projects by automating folder creation and transfer
75+
during acquisition and analysis. Its graphical interface or Python API builds
76+
folder trees according to the [NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev)
77+
specification. Automation and validation ensures that no errors, such as duplicate session
78+
names or incorrect dates, slip into the project.
79+
80+
Data can be transferred between acquisition, storage and analysis
81+
machines with a single function call or button click. Standardisation makes
82+
folder names predictable, meaning it is easy to transfer specific combinations
83+
of subjects, sessions or data-types with ``datashuttle``.
84+
85+
Folders are standardised to the
86+
[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev) specification:
87+
88+
```{image} /_static/NeuroBlueprint_project_tree_dark.png
89+
:align: center
90+
:class: only-dark
91+
:width: 550px
92+
```
93+
```{image} /_static/NeuroBlueprint_project_tree_light.png
94+
:align: center
95+
:class: only-light
96+
:width: 550px
97+
```
5598

56-
Don't hesitate to get in contact through our
57-
[GitHub Issues](https://github.com/neuroinformatics-unit/datashuttle/issues)
58-
or
59-
[Zulip Chat.](https://neuroinformatics.zulipchat.com/#narrow/stream/405999-DataShuttle)
99+
Dive in with our [Getting Started page](pages/get_started/index)
100+
or targeted [User Guides](pages/user_guides/index).
60101

102+
Have questions, issues or feedback? Get in contact through
103+
[GitHub issues](https://github.com/neuroinformatics-unit/datashuttle/issues)
104+
or our
105+
[Zulip chat.](https://neuroinformatics.zulipchat.com/#narrow/stream/405999-DataShuttle)
61106

62107
```{toctree}
63108
:maxdepth: 2
64109
:caption: index
65110
:hidden:
66111
67-
pages/tutorials
68-
pages/how_tos
69-
pages/community/index.md
112+
pages/get_started/index
113+
pages/user_guides/index
114+
pages/examples/index
115+
pages/community/index
70116
pages/api_index
71117
```

0 commit comments

Comments
 (0)