-
-
Notifications
You must be signed in to change notification settings - Fork 208
Update contributor guide for JB2 #285
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
Conversation
Too much info for contrib landing page, and description of tooling is out-of-date.
bsipocz
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor things, but also, I would strongly prefer to not duplicate content but either include the source or directly link out to the rendered page/source code file to minimise diverging instructions/content.
|
You didn't touched the screencaptures in the dropdowns, but I feel those are outdated, too. |
Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com>
Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com>
Agreed! I think the right way to do it is move this stuff to
Indeed - I'd like to remove them entirely, but I didn't want to include that in this PR in case it was controversial. The way I see it, those screenshots are more "here's how to use git/github", which I'd like to link to rather than repeat. I still propose to do so in another PR though so it doesn't block this one! Footnotes
|
Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com>
bsipocz
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, rendering looks good now, go ahead with merge as is if you like!
Thanks @bsipocz ! I will do so so I can start working on the deduplication! |
* DOC: Rm bit about myst-nb and jupytext - different toolchain. * DOC: rm bit about why notebooks. Too much info for contrib landing page, and description of tooling is out-of-date. * DOC: Add quickstart for using jb2. * DOC: Same changes in readme. --------- Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com> 9079207
* DOC: Rm bit about myst-nb and jupytext - different toolchain. * DOC: rm bit about why notebooks. Too much info for contrib landing page, and description of tooling is out-of-date. * DOC: Add quickstart for using jb2. * DOC: Same changes in readme. --------- Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com> 9079207
@rossbar - we should really turn off these actions on your fork 😅 |
Minimal updates to the contributor guide to highlight the new JB2 workflow. There's still plenty to be done; my main goal in this PR is to:
myst-nbandjupytext