Skip to content

Conversation

@rossbar
Copy link
Collaborator

@rossbar rossbar commented Nov 21, 2025

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:

  1. Remove out-of-date references to myst-nb and jupytext
  2. Add a minimal workflow for working with the site locally.

@rossbar rossbar added the documentation Improvements or additions to documentation label Nov 21, 2025
Copy link
Member

@bsipocz bsipocz left a 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.

@bsipocz
Copy link
Member

bsipocz commented Nov 25, 2025

You didn't touched the screencaptures in the dropdowns, but I feel those are outdated, too.

rossbar and others added 2 commits November 25, 2025 10:41
Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com>
Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com>
@rossbar
Copy link
Collaborator Author

rossbar commented Nov 25, 2025

After re-reading the original issue, I realized the question might also be about whether there exist algorithmic approaches that directly target cycles above a minimum length.

Agreed! I think the right way to do it is move this stuff to contributing.md in the main directory then use {include} and/or {embed} directives in the site to dedup the content. This involves splitting/moving files around though so I prefer to do it in a separate PR where the diffs don't contain both moved and changed content.1

You didn't touched the screencaptures in the dropdowns, but I feel those are outdated, too.

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

  1. I only noticed the duplication after I started working on the content, otherwise I would've done it the other way around 🙃

Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com>
Copy link
Member

@bsipocz bsipocz left a 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!

@rossbar
Copy link
Collaborator Author

rossbar commented Nov 25, 2025

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!

@rossbar rossbar merged commit 9079207 into numpy:main Nov 25, 2025
9 checks passed
@rossbar rossbar deleted the update-contrib-guide-jb2 branch November 25, 2025 18:57
github-actions bot pushed a commit that referenced this pull request Nov 25, 2025
* 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
github-actions bot pushed a commit to rossbar/numpy-tutorials that referenced this pull request Nov 25, 2025
* 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
@bsipocz
Copy link
Member

bsipocz commented Nov 25, 2025

pushed a commit to rossbar/numpy-tutorials

@rossbar - we should really turn off these actions on your fork 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants