Skip to content

docs: fix broken jetify.com documentation links (404s)#2848

Open
mikeland73 wants to merge 2 commits into
mainfrom
claude/focused-goldberg-8NTtl
Open

docs: fix broken jetify.com documentation links (404s)#2848
mikeland73 wants to merge 2 commits into
mainfrom
claude/focused-goldberg-8NTtl

Conversation

@mikeland73
Copy link
Copy Markdown
Collaborator

Summary

Fixes #2769

The documentation links in README.md (and many example READMEs) point to the old URL prefix https://www.jetify.com/devbox/docs/..., which now returns 404. The docs site moved to the https://www.jetify.com/docs/devbox/... scheme.

This PR normalizes every broken occurrence of jetify.com/devbox/docsjetify.com/docs/devbox.

Why this is the correct target

The repo already uses both schemes inconsistently. Notably, the .envrc files that devbox itself generates (e.g. examples/development/go/hello-world/.envrc) already use the new, working scheme:

# check out https://www.jetify.com/docs/devbox/ide_configuration/direnv/

and several example READMEs already use https://www.jetify.com/docs/devbox/installing-devbox/index. This change brings the remaining stale links in line with that canonical scheme.

Note: The container running this fix has no outbound access to jetify.com (all requests return 403), so the target scheme was confirmed from in-repo evidence rather than a live HTTP check. The two links explicitly cited in the issue are both covered:

  • https://www.jetify.com/devbox/docs/cli_reference/devbox/https://www.jetify.com/docs/devbox/cli_reference/devbox/
  • https://www.jetify.com/devbox/docs/contributor-quickstart/https://www.jetify.com/docs/devbox/contributor-quickstart/

Changes

  • 28 link fixes across 16 files (README.md, examples/**/README.md, plugins/README.md, vscode-extension/src/devbox.ts).
  • Image/shield URLs (jetify.com/img/devbox/..., jetify.com/devbox/img/...) were intentionally left untouched — only the /devbox/docs/ documentation prefix was changed.

Testing

  • No code behavior changes; documentation/links only (plus one VS Code extension "open external URL" string).
  • Verified zero remaining occurrences of the broken prefix: grep -rIn "jetify.com/devbox/docs" . returns nothing.

cc @pmorch (issue reporter) — thanks for flagging this!


Generated by 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
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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
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