Skip to content

feat: add missing jig convert information #417

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.

Sign up for GitHub

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

Open
tuxmea wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: add missing jig convert information #417

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4a725e
feat: add missing jig convert information
tuxmea Jul 22, 2026
c514b3d
Add Copilot grammar and spelling suggestions
tuxmea Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/_ecosystem_8x/devkit/migrating.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ When migrating away from the PDK, the biggest change you'll notice that instead
Most are shipped as gems that you'll add to a module's `Gemfile`.
This means that you'll maintain your own Ruby and Bundler installs, but most other tooling will be accessed via `bundle exec` commands in individual module repositories.

For simplicity, a convert command was added to Jig starting with version 1.5.0. This allows you to automatically update your module's `Gemfile`, `Rakefile`, and `spec/spec_helper.rb` to OpenVox- and VoxBox-compatible versions.

@miharp miharp Jul 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small wording suggestion to match the style guide: active voice and second person
per the tone guidelines, jig convert in monospace so it matches
the table row it explains, and one sentence per line like the surrounding paragraphs.

Suggested change
For simplicity, a convert command was added to Jig starting with version 1.5.0. This allows you to automatically update your module's `Gemfile`, `Rakefile`, and `spec/spec_helper.rb` to OpenVox- and VoxBox-compatible versions.
Jig 1.5.0 and later includes a `jig convert` command that migrates a PDK-based module for you.
It rewrites the module's `Gemfile`, `Rakefile`, and `spec/spec_helper.rb` to OpenVox- and VoxBox-compatible versions.


Before running commands in a new module repository, you'll need to run `bundle install`.
If you get an error about a command not being available, you probably just need to run `bundle install`.

Expand All @@ -23,12 +25,12 @@ Because Jig does not attempt to hide the Bundler environment from you, it will s
{% include alert.html type="tip" title="Choosing command forms" content="If you want quick and familiar commands to run locally, then use the Jig wrapper commands. If you're running tests and such in CI or if you need to pass custom options then invoke the tools directly." %}

| You used to type... | Now you type... | Or run tools directly... |
|---------------------|------------------|----------------------------------|
| ---------------------| ------------------| ----------------------------------|

@miharp miharp Jul 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this delimiter change intentional?

It adds a space after each opening pipe but not before the closing one, so the
delimiter row no longer lines up with the header and body rows. As far as I can
tell this is the only table in docs/ shaped that way — 28 files use | --- |
and 7 use |---|.

It renders fine either way, so no real harm. Just wondering whether it's worth
reverting to keep the diff focused on the jig convert change?

| `pdk new module` | `jig new module` | |
| `pdk new class` | `jig new class` | |
| `pdk build` | `jig build` | |
| `pdk release` | `jig release` | |
| `pdk convert` | _not needed_ | |
| `pdk convert` | `jig convert` | |
| `pdk update` | `jig update`* | `bundle exec msync update`* |
| `pdk validate` | `jig validate` | `bundle exec rake validate lint` |
| `pdk test unit` | `jig test unit` | `bundle exec rake spec` |
Expand Down