Instructions for how to update the specification with a BEP

[choldgraf]

Is there a place with instructions for how to update the BIDS specification with a new BEP? I think we're ready to go soon with BIDS-iEEG, and wonder if we can use this as an opportunity to improve the docs around contributing to the markdown etc.

[emdupre]

I know there's the BIDS Contributor Guide -- I think we decided against putting this in the starter kit, though I can't quite remember why -- maybe @KirstieJane would know ?

Regardless, there's still a lot here that references google docs, and I'm not sure if the whole thing should be converted to Markdown !

[chrisgorgo]

Indeed the Contributor Guide explains the procedure and has been updated a while ago to mention the need for sending a Pull Request with the BEP in Markdown form.

I think it is a great idea to improve the docs - starting from porting Contributor Guide to Markdown and incorporating it into this repo.

[choldgraf]

As a first start, how about we add a section to the bids-specification docs for this, and just link to the google doc?

[chrisgorgo]

Sounds good to me!

[emdupre]

Right now it's linked in the text under the table for current BEPs -- would you think that part should all be moved to its own section ? Or just this guide ?

…

On Mon., Nov. 26, 2018, 22:39 Chris Holdgraf ***@***.*** wrote: As a first start, how about we add a section to the bids-specification website for this, and just link to the google doc? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#96 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AOUk55USJ2Uuq9lOVw6_EaZf7tgFgVVCks5uzLQLgaJpZM4YzuoC> .

[choldgraf]

Ahh I see it - IMO those could live in their own separate section so that they show up in the navbar on the left and are more discoverable that way. What if we:

1. Made a section for "Extending the BIDS specification" at the end and move the current text there.
2. Replace that text with a short description of the extension process and link out to the new page for more information.

(note that here I'm trying not to make the navbar title something like "BIDS Extensions" because I think it'll confuse people into thinking of "extension" as in "firefox or chrome extension" not as in "modifying the BIDS specification")

[emdupre]

I'd +1 having all of the BEPs (and the guide) as their own section from the navbar ! So that sounds good to me 👍

[emdupre]

It looks like the links added here aren't rendering correctly :(

https://bids-specification.readthedocs.io/en/latest/06-extensions.html

[choldgraf]

ahhh I bet it's because of the line break that I added to try and not violate line length limits...

[emdupre]

Should we re-open this issue, @chrisfilo ?