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

make the Benefits page readable: add Converters TOC #369

Draft
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from

Conversation

christinerogers
Copy link
Contributor

@christinerogers christinerogers commented Mar 13, 2024

To upgrade the Benefits page from an unfriendly scroll journey --

This PR adds internal links in the Converters section and a mini-TOC for them

upgrading us from a very unfriendly scroll journey
Copy link

netlify bot commented Mar 13, 2024

Deploy Preview for astounding-beignet-8ca2d6 ready!

Name Link
🔨 Latest commit a1ea168
🔍 Latest deploy log https://app.netlify.com/sites/astounding-beignet-8ca2d6/deploys/65f1f357eb85160007908360
😎 Deploy Preview https://deploy-preview-369--astounding-beignet-8ca2d6.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

hopefully this fixes the markdown
@christinerogers christinerogers changed the title making the Converters section Readable making the Benefits page readable: add Converters TOC Mar 13, 2024
@christinerogers christinerogers changed the title making the Benefits page readable: add Converters TOC make the Benefits page readable: add Converters TOC Mar 13, 2024
Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for the TOC, but let's use the headings that are automatically generated -- with the current changes (without my suggestions), we'd have duplicates, see: https://deploy-preview-369--astounding-beignet-8ca2d6.netlify.app/benefits#data-converters

image

Comment on lines +15 to +20
Tools which convert data to/from BIDS :
* [Data converters](#data-converters)
* [MEEG converters](#meeg-converters)
* [from BIDS converters](#from-bids-converters)
* [Physio converters](#physio-converters)
* [Other converters](#other-converters)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Tools which convert data to/from BIDS :
* [Data converters](#data-converters)
* [MEEG converters](#meeg-converters)
* [from BIDS converters](#from-bids-converters)
* [Physio converters](#physio-converters)
* [Other converters](#other-converters)
Software tools to convert data to or from BIDS:
- [MRI and PET converters](#mri-and-pet-converters)
- [EEG, MEG, iEEG converters](#eeg-meg-ieeg-converters)
- ['From BIDS' converters](#from-bids-converters)
- [Physiological data converters](#physiological-data-converters)
- [Miscellaneous](#miscellaneous)

Comment on lines +22 to 42
### Data converters

{% include converters_table.html members=site.data.converters %}

### MEEG converters

{% include converters_table.html members=site.data.MEEG_converters %}

### from BIDS converters

{% include converters_table.html members=site.data.from_BIDS_converters %}

### Physio converters

{% include converters_table.html members=site.data.physio_converters %}

### Other converters

{% include converters_table.html members=site.data.other_converters %}

# Software currently supporting BIDS:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Data converters
{% include converters_table.html members=site.data.converters %}
### MEEG converters
{% include converters_table.html members=site.data.MEEG_converters %}
### from BIDS converters
{% include converters_table.html members=site.data.from_BIDS_converters %}
### Physio converters
{% include converters_table.html members=site.data.physio_converters %}
### Other converters
{% include converters_table.html members=site.data.other_converters %}
# Software currently supporting BIDS:
{% include converters_table.html members=site.data.converters %}
{% include converters_table.html members=site.data.MEEG_converters %}
{% include converters_table.html members=site.data.from_BIDS_converters %}
{% include converters_table.html members=site.data.physio_converters %}
{% include converters_table.html members=site.data.other_converters %}
# Software currently supporting BIDS:

@Remi-Gau Remi-Gau marked this pull request as draft May 9, 2024 20:21
@Remi-Gau
Copy link
Contributor

Remi-Gau commented May 9, 2024

probably worth revisiting this PR to see if what's main looks "good enough"

https://bids-website.readthedocs.io/en/latest/tools/converters/

@christinerogers
Copy link
Contributor Author

I think we've lost something with the subpages here. -- the ability to search the page for (e.g.) "EEG" since a lot of tools are under one category but could be under multiple.
is it easy to add a "search all converters" box/feature or is a table of contents left-side still with a long scroll in the main panel worth trying?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants