bids-website icon indicating copy to clipboard operation
bids-website copied to clipboard

reorganize schema section

Open Remi-Gau opened this issue 1 year ago • 4 comments

For the schema, there is one obscure link in the website that points to the README of the schema. I think this README should either be made WAY more obvious. Note that a more user friendly rendering of this README is available on the BIDS schema tools RTD. In the spirit of avoiding having information scattered Another option would be to render file as part of the spec itself around this page. @effigies what do you think?

  • from https://github.com/bids-standard/bids-website/issues/518

Remi-Gau avatar Oct 18 '24 14:10 Remi-Gau

The README in the spec website is just an accident of mkdocs rendering any markdown it finds. It is intended to be descriptive and not at all make statements that we need to retain backwards compatibility, so it would probably be better to remove it from the specification website, if mkdocs allows us to exclude files.

effigies avatar Oct 18 '24 15:10 effigies

Sorry, just realized this is the website. Yes, if we're linking to the README, we should switch to the bidsschematools RTD.

effigies avatar Oct 18 '24 15:10 effigies

you can exclude files

see for example

https://github.com/bids-standard/bids-website/blob/2cf8af9ccbfc34020a305eb0f118f4adafc7976e/mkdocs.yml#L81

Remi-Gau avatar Oct 18 '24 15:10 Remi-Gau

by the way would it not be better to render this schema page (https://bidsschematools.readthedocs.io/en/latest/description.html) in the bids spec website rather than on the doc of bidschematools

cannot remember the rationale for rendering it there

Remi-Gau avatar Oct 18 '24 15:10 Remi-Gau