neurobagel / documentation

The neurobagel documentation
http://neurobagel.org/
MIT License
10 stars 6 forks source link

Fix links to example CLI inputs #81

Closed alyssadai closed 1 year ago

alyssadai commented 1 year ago

Broken links on:

take a look at https://github.com/marketplace/actions/check-links-with-linkcheck, also @Remi-Gau might have some advice on checking for dead links in the docs, I know that's one of the CI jobs for BIDS.

Remi-Gau commented 1 year ago

Yup there are a couple of tools out there to check links in MD documents. I can set it up if you want.

Remi-Gau commented 1 year ago

here is an example: https://github.com/bids-standard/bids-website/blob/gh-pages/.github/workflows/check_md_links.yml

and the associated config: https://github.com/bids-standard/bids-website/blob/gh-pages/md_link_check_config.json

rmanaem commented 1 year ago

Thanks @Remi-Gau!

rmanaem commented 1 year ago

@alyssadai

also, move tip box containing examples further up. Actually, the contents should probably be moved out of the tip box in to its own section called "Example data dictionary" or something. This section could come before or after the "Phenotypic attributes" section

I think that text is too small for a section, how about we move it above phenotypic attributes and put it in an info box instead of a tip box?

alyssadai commented 1 year ago

Hey @rmanaem, sure, we can leave it in an info box.

The goal would be to make the examples super easy to find on the page, so -

how about we move it above phenotypic attributes

yes, I think it should be in the Overview section, maybe under the introductory sentence?