jonescompneurolab / hnn-core

Simulation and optimization of neural circuits for MEG/EEG source estimates
https://jonescompneurolab.github.io/hnn-core/
BSD 3-Clause "New" or "Revised" License
54 stars 52 forks source link

[MRG] Add governance structure and update README #785

Closed dylansdaniels closed 3 months ago

dylansdaniels commented 4 months ago

Hi, I create a new governance structure .rst file and updated the README.rst to point to where the gh page will be hosted once published... I rendered the html files locally and they look good to me. I'm unclear on the process for posting the .html files generated...is there an Action that makes them automatically? is that a separate PR under the gh-pages branch? thx :)

rythorpe commented 4 months ago

This is great @dylansdaniels! I believe all .rst files within the doc directory get compiled and pushed to the gh-pages branch automatically by CircleCI.

Looks like linkcheck is failing but I think that's because its testing the link to the governance.html webpage which doesn't exist yet.

jasmainak commented 4 months ago

Perhaps add the html link in a follow up PR so we keep the CIs happy?

samadpls commented 4 months ago

Hi @dylansdaniels, Following up on our meeting discussion, I wanted to suggest a small update to the README.md file. As we mentioned, updating the #Roadmap link would be helpful for users.

dylansdaniels commented 4 months ago

@jasmainak sounds good, I can remove the http link for now :-)

@samadpls I think we landed on removing the roadmap entirely since it's out of date. I think it makes sense to lump that in with the f/u PR since that will be changing the README anyway?

dylansdaniels commented 4 months ago

Shall I change prefix to [MRG]?

jasmainak commented 3 months ago

Thanks @dylansdaniels !!