docs: fix broken jetify.com documentation links - #2848
Conversation
The documentation site moved from the /devbox/docs/ URL prefix to /docs/devbox/, leaving the links in README.md and various example READMEs returning 404s. This updates all occurrences of jetify.com/devbox/docs to jetify.com/docs/devbox, matching the URL scheme already used by devbox-generated .envrc files. Fixes #2769
There was a problem hiding this comment.
Pull request overview
This PR fixes broken Jetify Devbox documentation links across the repository by updating the deprecated https://www.jetify.com/devbox/docs/... URL prefix to the new https://www.jetify.com/docs/devbox/... scheme, addressing the 404s reported in #2769.
Changes:
- Updated Devbox documentation links in the main
README.mdand multiple example READMEs to usehttps://www.jetify.com/docs/devbox/.... - Updated the plugins contribution README to point at the new docs path.
- Updated the VS Code extension’s “See Devbox docs” external link target to the new docs path.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
vscode-extension/src/devbox.ts |
Updates the docs URL opened from the VS Code extension on Windows. |
README.md |
Fixes top-level docs links (install, quickstart, CLI ref, contributor quickstart) to the new docs scheme. |
plugins/README.md |
Fixes the plugin user documentation link to the new docs scheme. |
examples/tutorial/README.md |
Fixes tutorial “Next Steps” links to the new docs scheme. |
examples/stacks/rails/README.md |
Fixes related docs link to the new docs scheme. |
examples/stacks/lepp-stack/README.md |
Fixes related docs links to the new docs scheme. |
examples/stacks/lapp-stack/README.md |
Fixes related docs links to the new docs scheme. |
examples/stacks/jekyll/README.md |
Fixes badge and related docs links to the new docs scheme. |
examples/stacks/django/README.md |
Fixes badge and related docs links to the new docs scheme. |
examples/README.md |
Fixes badge link to contributor quickstart on the new docs scheme. |
examples/flakes/README.md |
Fixes “using flakes” guide link to the new docs scheme. |
examples/development/ruby/README.md |
Fixes related docs links to the new docs scheme. |
examples/development/haskell/my-project/README.md |
Fixes Haskell docs link to the new docs scheme. |
examples/data_science/tensorflow/README.md |
Fixes quickstart install anchor link to the new docs scheme. |
examples/data_science/llama/README.md |
Fixes quickstart install anchor link to the new docs scheme. |
examples/cloud_development/temporal/README.md |
Fixes badge link to contributor quickstart on the new docs scheme. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…rg-8NTtl # Conflicts: # README.md
…BUTING badge, envrc template) The docs site now uses hyphenated paths (devbox-examples, using-flakes, ide-configuration), the contributor-quickstart page no longer exists (link the badge to CONTRIBUTING.md, as the root README already does), and the shield image lives under img/devbox/. Also fixes the .envrc template so newly generated files get a working link. Every jetify.com URL in the repo now resolves with HTTP 200. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
@claude please review |
|
Claude finished @mikeland73's task in 50s —— View job Reviewing PR #2848
ReviewThis is a clean, low-risk documentation fix. I checked the full diff ( What's good:
Nothing else to flag — I didn't find any remaining broken |
|
|
||
| [](https://www.jetify.com/devbox/docs/contributor-quickstart/) | ||
| [](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md) | ||
|
|
There was a problem hiding this comment.
This badge link doesn't match the PR's described transformation. The PR description says this link should become https://www.jetify.com/docs/devbox/contributor-quickstart/ (prefix swap only), but the diff instead retargets it entirely to https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md:
Lines 2 to 4 in 87c1de4
The same undisclosed retarget is also applied in examples/stacks/django/README.md, examples/stacks/jekyll/README.md, and examples/cloud_development/temporal/README.md. Worth confirming this is intentional and updating the PR description accordingly, since it's a different domain/resource than what was promised.
|
|
||
| [](https://www.jetify.com/devbox/docs/contributor-quickstart/) | ||
| [](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md) | ||
|
|
There was a problem hiding this comment.
Same badge-retarget issue as in examples/README.md: the PR description promises a /devbox/docs/ → /docs/devbox/ prefix swap (i.e. https://www.jetify.com/docs/devbox/contributor-quickstart/), but this link was instead changed to a different domain/resource entirely:
devbox/examples/stacks/django/README.md
Lines 2 to 4 in 87c1de4
Worth confirming this is intentional.
|
|
||
| [](https://www.jetify.com/devbox/docs/contributor-quickstart/) | ||
| [](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md) | ||
|
|
There was a problem hiding this comment.
Same badge-retarget issue as in examples/README.md: the PR description promises a /devbox/docs/ → /docs/devbox/ prefix swap (i.e. https://www.jetify.com/docs/devbox/contributor-quickstart/), but this link was instead changed to a different domain/resource entirely:
devbox/examples/stacks/jekyll/README.md
Lines 2 to 4 in 87c1de4
Worth confirming this is intentional.
|
|
||
| [](https://www.jetify.com/devbox/docs/contributor-quickstart/) | ||
| [](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md) | ||
|
|
There was a problem hiding this comment.
Two undisclosed changes on this line:
- The badge link target was changed to
https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md, rather than the/devbox/docs/→/docs/devbox/prefix swap described in the PR (same asexamples/README.md,examples/stacks/django/README.md,examples/stacks/jekyll/README.md). - The image
srcitself was rewritten fromjetify.com/devbox/img/shield_galaxy.svgtojetify.com/img/devbox/shield_galaxy.svg, despite the PR description explicitly stating image/shield URLs were left untouched.
devbox/examples/cloud_development/temporal/README.md
Lines 2 to 4 in 87c1de4
Both are plausibly correct normalizations (they match the convention used elsewhere in the repo), but neither matches what the PR description promises — worth double-checking and updating the description.
|
|
||
| # check out https://www.jetify.com/docs/devbox/ide_configuration/direnv/ | ||
| # check out https://www.jetify.com/docs/devbox/ide-configuration/direnv/ | ||
| # for more details |
There was a problem hiding this comment.
This URL already had the correct /docs/devbox/ prefix — the PR description even cites this exact line as in-repo evidence for the correct scheme. The only change made here is an undisclosed ide_configuration → ide-configuration slug rename:
devbox/internal/devbox/generate/tmpl/envrc.tmpl
Lines 7 to 9 in 87c1de4
The same unverified underscore-to-hyphen rewrite is also applied to the root .envrc, 8 example .envrc files, several README "Related Docs" links (devbox_examples→devbox-examples, using_flakes→using-flakes), and vscode-extension/src/devbox.ts. Since the PR description notes the author had no outbound network access to verify jetify.com, this slug rename is unverified and risks turning currently-working links into new 404s — most consequentially here, since this template's text is baked into every .envrc Devbox generates for end users.
Summary
Fixes #2769
Documentation links across the repo pointed at the old
https://www.jetify.com/devbox/docs/...prefix, which now 404s. The docs site lives athttps://www.jetify.com/docs/devbox/..., and its page slugs use hyphens rather than underscores (devbox-examples,using-flakes,ide-configuration).This PR moves every stale link to the new prefix and the hyphenated slugs, so each link resolves to a live page rather than a 404 or a redirect.
Changes
jetify.com/devbox/docs/…→jetify.com/docs/devbox/…everywhere.devbox_examples→devbox-examples,using_flakes→using-flakes,ide_configuration→ide-configuration). The underscore variants return 404 even under the new prefix.examples/cloud_development/temporal/README.md: badge imagejetify.com/devbox/img/shield_galaxy.svg→jetify.com/img/devbox/shield_galaxy.svg(the former path was also stale).internal/devbox/generate/tmpl/envrc.tmpl: the.envrccomment devbox generates now points at the working direnv docs URL, so newly generated projects don't ship a broken link. The checked-in example.envrcfiles were updated to match.vscode-extension/src/devbox.ts: the "See docs" URL for the WSL warning.25 files, 34 line changes; no behavior changes beyond the two URL strings above.
Verification
Every unique
jetify.comURL in the tree (28) was checked over HTTP after the change:#fragmentlinks (quickstart/#install-devbox,ide-configuration/vscode/#windows-setup) target heading ids that exist on those pages.git grep 'jetify.com/devbox/docs'returns nothing.Side note for whoever owns the docs site (not addressable in this repo): rendered heading ids carry a trailing zero-width space (e.g.
id="install-devbox"), which may keep browsers from scrolling to#install-devbox.cc @pmorch (issue reporter) — thanks for flagging this!
🤖 Generated with Claude Code