Skip to content

Document jig convert on the Jig reference page #422

Description

@miharp

Summary

jig convert is currently documented in a single sentence on the migration page, with no invocation example and no coverage on the Jig reference page itself.

Current state

The command appears in exactly two places, both in docs/_ecosystem_8x/devkit/migrating.md:

  • a one-sentence paragraph noting it exists as of Jig 1.5.0
  • the PDK-equivalence table row, pdk convert -> jig convert

docs/_ecosystem_8x/devkit/jig.md is the reference page for Jig. It documents jig new module, jig new class, the config file at ~/.config/jig/config.toml, and custom templates. It does not mention convert at all.

Why this matters

A reader migrating from the PDK follows the table to jig convert and gets one sentence. There is no answer to the obvious next questions:

  • How do you invoke it? (Presumably from the module root, but the docs do not say.)
  • What does it do to files that already exist? Does it overwrite, merge, or skip?
  • Is it safe to re-run on an already-converted module?
  • Is there a way to preview changes before they are written?

This is the most useful command in the migration path, and it currently has the thinnest documentation on the page.

Suggested fix

Minimum: add a console example alongside the existing paragraph in migrating.md, per the "provide command or code examples for common scenarios" guidance in CONTRIBUTING.md.

cd my-module
jig convert

Better: add a short "Converting an existing PDK module" section to jig.md covering invocation and file-overwrite behavior, and link to it from migrating.md.

Notes

  • The command landed in voxpupuli/jig#69, released in v1.5.0 (2026-07-19).
  • Jig v2.0.0 released 2026-07-21. Worth confirming convert behaves the same in 2.x before writing this up, since that is the version readers will install.
  • Follow-up to feat: add missing jig convert information #417, which added the initial mention. Not a blocker for that PR.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions