Refresh the DevKit jig pages for jig 2.x - #480
Merged
Merged
Conversation
The scaffolding, migration, linting, and publishing pages described jig as of 1.5. Bring them up to jig 2.3: - jig convert works on any module with a metadata.json, not only PDK ones; drop the 1.5.0 version notes. - jig update was renamed jig msync update in 2.0. - jig validate runs rubocop as well as validate and lint, with -s/-l/-r flags to pick a subset. - Regenerate the jig new module tree (jig.toml, acceptance spec scaffolding) and add sections on jig.toml, the .tmpl rendering rule and literal-path template tree, jig templates resolve, remote template repositories, jig renew, the Ruby-backed commands and the VoxBox runner, and jig convert. Cross-link from the VoxBox and unit testing pages. - jig build no longer reads .pdkignore/.pmtignore and packages the module spec allowlist by default, with a [build] section in jig.toml for exceptions; document that and the jig release flags. Closes OpenVoxProject#466 Signed-off-by: Michael Harp <mike@mikeharp.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
jig 2.4.0 shipped the convert changes from jig#92 and jig#93: the Modulefile pre-fill also carries project_page, repair keeps unknown keys and modernizes bare-list operatingsystem_support, and convert now removes a stale Gemfile.lock and warns about PDK-era files it leaves behind. Name the version instead of "upgrade Jig" and update the migration transcript. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
avitacco
approved these changes
Sep 10, 2026
avitacco
left a comment
avitacco
left a comment
There was a problem hiding this comment.
This looks great, thank you for updating the documentation!
binford2k
approved these changes
Sep 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The DevKit pages under
ecosystem/devkit/described jig as it was around 1.5. This brings the scaffolding, migration, linting, and publishing pages up to jig 2.4.0, released 2026-09-10.Closes #466. Pairs with #465, whose CI page links to the
jig convertsection this PR adds instead of jig's GitHub docs.What changed
devkit/jig.mdjig new moduletree (jig.toml, acceptance spec scaffolding). New sections onjig.toml, the.tmplrendering rule and literal-path template tree,jig templates resolve, remote template repositories,jig renew, the Ruby-backed commands and the VoxBox runner, and a fulljig convertsection: missing, broken, incomplete, and validmetadata.jsoncases,Modulefilepre-fill, the interview flags,--dry-run,Gemfile.lockremoval and the PDK-era file warning (jig#92 and jig#93, both in 2.4.0)devkit/migrating.mdjig convertis not PDK-specific and no longer needsmetadata.jsonto exist; 1.5.0 version notes dropped;pdk updatemaps tojig msync update(renamed in 2.0, with a pointer tojig renewfor single-module refreshes);jig validatealso runs rubocop, with the-s/-l/-rflags; sample transcript updated to 2.4.0 outputdevkit/linting.mdjig validatescope corrected (rubocop included unless-sl)devkit/publishing.mdjig buildbehavior:.pdkignore/.pmtignoreignored, module-spec allowlist by default,[build]section injig.tomlfor exceptions,jig releaseflagsdevkit/voxbox.md[runner] type = "voxbox"in the Jig config runsjig validate,jig test unit, andjig msyncthrough the container, with a cross-link to the Ruby-backed commands sectiondevkit/unit_testing.mdjig test unit --parallelVerification
docs/tree at thev2.4.0tag and against the 2.4.0 darwin binary:jig convertrun on a Modulefile-era module, on a module with no metadata (--skip-interview), and on a PDK-style module with an incompletemetadata.json, a staleGemfile.lock,.sync.yml, and.pdkignore. Output matches what the pages describe, including theGemfile.lockremoval and the PDK-era warning, and a second run is a no-op on metadata.bundle exec jekyll buildsucceeds and every in-page and cross-page anchor resolves in_site.