search

learn-neuroimaging / hitchhackers_guide_brain

A list of tutorials and other resources useful to learn open science and neuroimaging, EEG and MEG
https://learn-neuroimaging.github.io/hitchhackers_guide_brain/
Other
114 stars 42 forks source link

[WIP] setting up templates #70

Closed Remi-Gau closed 4 years ago

Remi-Gau commented 4 years ago

This is a work in progress to set up templates.

It also implements the drop down boxes by using some extension of MKDOCS material.

Fixes issue #57

Related to issue #43

TO DO

mkdocs_sample_templates

Remi-Gau commented 4 years ago

I am more or less OK with how this looks for now.

@roopa-pai @alexandreroutier I would need another pair of eyes to double check that those templates look fine (not too complicated to discourage their use and not too simple that they might be missing some important information).

roopa-pai commented 4 years ago

Some thoughts: I think it's neither too simple nor too complicated. However, the links (e.g. software>code repository) are broken in the example, which may be confusing.

Remi-Gau commented 4 years ago

good point.

Since they are dummy examples it might be weird to make them point to to actual stuff.

Maybe I can present the actual markdown code and show below what it would give.

Remi-Gau commented 4 years ago

@roopa-pai have a look now and let me know if it less confusing.

This also makes it easier for people to find the templates

Remi-Gau commented 4 years ago

Good point this might be a bit obscure.

Actually the thing is that this pull request will create a menu in the github "issue" tab where people get directly prompted with the correct code snippet for what they want to add.

See the BIDS specification issue tab. https://github.com/bids-standard/bids-specification/issues/new/choose

But you are correct that this totally requires a little extra to be more explicit. Thanks. :-)

Remi-Gau commented 4 years ago

Good point this might be a bit obscure.

Actually the thing is that this pull request will create a menu in the github "issue" tab where people get directly prompted with the correct code snippet for what they want to add.

See the BIDS specification issue tab. https://github.com/bids-standard/bids-specification/issues/new/choose

But you are correct that this totally requires a little extra to be more explicit. Thanks. :-)

roopa-pai commented 4 years ago

I see, that's perfect then!