Skip to content

docs: fix broken jetify.com documentation links - #2848

Merged
mikeland73 merged 9 commits into
mainfrom
claude/focused-goldberg-8NTtl
Sep 16, 2026
Merged

mikeland73 merged 9 commits into
mainfrom
claude/focused-goldberg-8NTtl

Conversation

@mikeland73

@mikeland73 mikeland73 commented Jun 5, 2026 •

Copy link
Copy Markdown
Collaborator

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 at https://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.
  • Underscore slugs → hyphenated slugs (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 image jetify.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 .envrc comment devbox generates now points at the working direnv docs URL, so newly generated projects don't ship a broken link. The checked-in example .envrc files 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.com URL in the tree (28) was checked over HTTP after the change:

  • All return 200 and none redirect to a different path (no soft-404s landing on a docs root).
  • The two #fragment links (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

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
Copilot AI review requested due to automatic review settings June 5, 2026 14:07

Copilot AI left a comment

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.

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.md and multiple example READMEs to use https://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.

Comment thread examples/tutorial/README.md Outdated
claude and others added 8 commits June 5, 2026 14:09
…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>
@mikeland73 mikeland73 changed the title docs: fix broken jetify.com documentation links (404s) docs: fix broken jetify.com documentation links Sep 16, 2026
@mikeland73

Copy link
Copy Markdown
Collaborator Author

@claude please review

@claude

claude Bot commented Sep 16, 2026 •

Copy link
Copy Markdown

Claude finished @mikeland73's task in 50s —— View job


Reviewing PR #2848

  • Gather context (PR description, diff, review comments)
  • Review the diff for correctness
  • Verify no stale links remain in the tree
  • Post review feedback

Review

This is a clean, low-risk documentation fix. I checked the full diff (git diff origin/main...HEAD, 24 files / 34 lines) and grepped the tree for the old patterns.

What's good:

  • jetify.com/devbox/docs/... → jetify.com/docs/devbox/... is applied consistently everywhere; grep -rn "jetify.com/devbox/docs" across the repo returns nothing.
  • Underscore → hyphen slug fixes (devbox_examples→devbox-examples, using_flakes→using-flakes, ide_configuration→ide-configuration) are applied consistently across all .envrc files, envrc.tmpl, the example READMEs, and vscode-extension/src/devbox.ts. No leftover underscore variants found.
  • The latest commit (87c1de4) correctly caught a real issue the earlier commits missed: the contributor-quickstart docs page doesn't exist under the new prefix, so those badge links (examples/README.md, examples/cloud_development/temporal/README.md, examples/stacks/django/README.md, examples/stacks/jekyll/README.md) now point at CONTRIBUTING.md on GitHub instead — matching the pattern the root README.md already uses. Good catch.
  • The shield_galaxy.svg / shield_moon.svg badge image paths are now consistent with the root README's img/devbox/shield_*.svg convention.
  • The Copilot review's "Checkout" → "Check out" grammar nit in examples/tutorial/README.md was already addressed in c052d56.
  • internal/devbox/generate/tmpl/envrc.tmpl fix means newly-generated .envrc files won't ship a dead link — good, since that template output isn't visible from a link checker unless you know to look at generated output.
  • Scope is well-contained: only URL strings changed, no behavior changes, no .github/workflows touched.

Nothing else to flag — I didn't find any remaining broken jetify.com links, mismatched badge images, or markdown syntax issues in the diff. This looks ready to merge as-is.

Comment thread examples/README.md
Comment on lines 2 to 4

[![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/)
[![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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:

[![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md)

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.

Comment on lines 2 to 4

[![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/)
[![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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:

[![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md)

Worth confirming this is intentional.

Comment on lines 2 to 4

[![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/)
[![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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:

[![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md)

Worth confirming this is intentional.

Comment on lines 2 to 4

[![Built with Devbox](https://www.jetify.com/devbox/img/shield_galaxy.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/)
[![Built with Devbox](https://www.jetify.com/img/devbox/shield_galaxy.svg)](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Two undisclosed changes on this line:

  1. 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 as examples/README.md, examples/stacks/django/README.md, examples/stacks/jekyll/README.md).
  2. The image src itself was rewritten from jetify.com/devbox/img/shield_galaxy.svg to jetify.com/img/devbox/shield_galaxy.svg, despite the PR description explicitly stating image/shield URLs were left untouched.

[![Built with Devbox](https://www.jetify.com/img/devbox/shield_galaxy.svg)](https://github.com/jetify-com/devbox/blob/main/CONTRIBUTING.md)

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.

Comment on lines 7 to 9

# 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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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:

# check out https://www.jetify.com/docs/devbox/ide-configuration/direnv/
# for more details

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.

@mikeland73
mikeland73 merged commit ad7f976 into main Sep 16, 2026
38 checks passed
@mikeland73
mikeland73 deleted the claude/focused-goldberg-8NTtl branch September 16, 2026 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

README.md has broken/404 links to jetlify.com

3 participants