Skip to content

Update Jig docs for the move to voxpupuli/jig and refresh to current CLI#349

Merged
tuxmea merged 2 commits into
OpenVoxProject:masterfrom
miharp:docs/jig-voxpupuli-move
Jun 20, 2026
Merged

Update Jig docs for the move to voxpupuli/jig and refresh to current CLI#349
tuxmea merged 2 commits into
OpenVoxProject:masterfrom
miharp:docs/jig-voxpupuli-move

Conversation

@miharp

@miharp miharp commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

What

The Jig scaffolding tool moved from github.com/avitacco/jig to github.com/voxpupuli/jig. This updates every reference and brings the prose in line with Jig's current CLI. All command syntax was validated against the Jig source.

Changes

Repo move:

  • Point all avitacco/jig links and the go install path at voxpupuli/jig.

Command / prose fixes (devkit/jig.md, modules_publishing.markdown):

  • Fix invalid commands (jig module build, jig build build, jig module) to the actual jig build.
  • Document the --skip-interview flag and its companion value flags on jig new module, plus the template-override precedence (--template-dir flag, then template_dir config key). The README's JIG_TEMPLATE_DIR env var does not reliably bind in the source, so it's intentionally left out.

Discoverability and naming:

  • Point the PDK page's jig "alternative" entry at our own /ecosystem/latest/devkit/jig.html docs (keeping a repo link for source/releases) and capitalize the proper noun "Jig".
  • Add a "see installation and usage" pointer from the DevKit components list to the Scaffolding page.
  • Add a cross-collection "Scaffolding modules with Jig" entry to the core OpenVox Modules nav. Cross-collection links use absolute paths per CONTRIBUTING.

jig validate / test unit / update:

  • migrating.md: map pdk update/validate/test unit to the jig commands, noting they wrap the underlying bundle exec calls (still need bundle install).
  • linting.md: note jig validate runs validate + lint (not lint_fix).
  • unit_testing.md: add the run command (jig test unit, wrapping bundle exec rake spec).

Validation

  • Verified the full command/flag set against the Jig source.
  • bundle exec jekyll build passes; spot-checked the cross-collection link, nav entry, and new command prose in the built site.

Closes #348

The Jig scaffolding tool moved from github.com/avitacco/jig to
github.com/voxpupuli/jig. Update every reference and bring the prose in
line with Jig's current CLI (validated against the jig source).

Repo move:
- Point all avitacco/jig links and the go install path at voxpupuli/jig.

Command/prose fixes:
- Fix invalid commands in modules_publishing (jig module build,
  jig build build, jig module) to the actual jig build command.
- Document the --skip-interview flag and its companion value flags on
  jig new module, and the template override precedence (the
  --template-dir flag, then the template_dir config key). The README's
  JIG_TEMPLATE_DIR env var does not reliably bind, so it is left out.

Discoverability and naming:
- Point the PDK page's jig 'alternative' entry at our own
  /ecosystem/latest/devkit/jig.html docs (keeping a repo link for
  source/releases) and capitalize the proper noun Jig.
- Add a 'see installation and usage' pointer from the DevKit components
  list to the Scaffolding New Content with Jig page.
- Add a cross-collection 'Scaffolding modules with Jig' entry to the
  core OpenVox Modules nav. Cross-collection links use absolute paths
  per CONTRIBUTING.

jig validate / test unit / update:
- migrating.md: map pdk update/validate/test unit to the jig commands,
  noting they wrap the underlying bundle exec calls (need bundle install).
- linting.md: note jig validate runs validate + lint (not lint_fix).
- unit_testing.md: add the run command (jig test unit, wrapping
  bundle exec rake spec).

Closes OpenVoxProject#348

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp miharp requested a review from a team as a code owner June 20, 2026 13:12
@miharp miharp marked this pull request as draft June 20, 2026 13:12
@miharp miharp marked this pull request as ready for review June 20, 2026 13:28
@tuxmea tuxmea enabled auto-merge June 20, 2026 14:04
@tuxmea tuxmea merged commit 5d5280b into OpenVoxProject:master Jun 20, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update jig docs for the move to voxpupuli/jig and refresh to current CLI

2 participants