Skip to content

docs: fix broken jetify.com documentation links (/devbox/docs → /docs/devbox)#2853

Open
mikeland73 wants to merge 4 commits into
mainfrom
claude/focused-goldberg-Y9yk3
Open

docs: fix broken jetify.com documentation links (/devbox/docs → /docs/devbox)#2853
mikeland73 wants to merge 4 commits into
mainfrom
claude/focused-goldberg-Y9yk3

Conversation

@mikeland73

Copy link
Copy Markdown
Collaborator

Summary

The Jetify documentation site reorganized its URL structure from jetify.com/devbox/docs/... to jetify.com/docs/devbox/.... The old links were left behind in README.md and other docs throughout the repo, and they now return 404.

This PR updates every occurrence of the legacy www.jetify.com/devbox/docs/... prefix to the current canonical www.jetify.com/docs/devbox/... format. The correct format is already used by the generated .envrc template (internal/devbox/generate/tmpl/envrc.tmpl) and the example .envrc files, so this just brings the rest of the repo in line.

What changed

  • README.md — fixes the 4 broken doc links, including the two explicitly reported in the issue:
    • …/contributor-quickstart/
    • …/cli_reference/devbox/
    • (also …/installing-devbox/ and …/quickstart/)
  • The same stale prefix in example/plugin READMEs and the VSCode extension (vscode-extension/src/devbox.ts) was corrected too, since they share the identical bug.

The change is a purely mechanical prefix correction — only the /devbox/docs/docs/devbox segment was touched. Image paths such as …/devbox/img/shield_galaxy.svg were intentionally left untouched.

Verification

  • Confirmed there are no remaining jetify.com/devbox/docs occurrences after the change.
  • The corrected prefix matches the canonical links already present in the repo (e.g. envrc.tmpl, example .envrc files).

Note: the docs site is behind a WAF that returns 403 to automated clients, so live HTTP verification of each URL wasn't possible from CI; correctness is established against the repo's own canonical usage.

Fixes #2769


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

🤖 Generated with Claude Code


Generated by Claude Code

The documentation site moved from `jetify.com/devbox/docs/...` to
`jetify.com/docs/devbox/...`, leaving the old links throughout the repo
returning 404. This updates every occurrence of the legacy path prefix
to the current canonical format, matching the URLs already used in the
generated `.envrc` template and the example `.envrc` files.

Fixes the broken README links reported in #2769, and applies the same
correction to the example/plugin READMEs and the VSCode extension that
shared the stale prefix.
Copilot AI review requested due to automatic review settings June 7, 2026 14:08

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 updates stale Jetify Devbox documentation URLs across the repository to match the documentation site’s new canonical structure (https://www.jetify.com/docs/devbox/...), fixing 404s reported in #2769 and aligning links with the format already used elsewhere in the repo.

Changes:

  • Replace the legacy https://www.jetify.com/devbox/docs/... prefix with https://www.jetify.com/docs/devbox/... in the root README and various example/plugin docs.
  • Update the VSCode extension’s “See Devbox docs” link to the new canonical docs URL.
  • Keep non-doc asset URLs (e.g., images under /img/...) unchanged as intended.

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 VSCode “See Devbox docs” link to the new docs URL prefix.
README.md Fixes multiple broken Devbox documentation links to use the canonical /docs/devbox path.
plugins/README.md Updates the plugins guide link to the new docs URL structure.
examples/tutorial/README.md Updates “Next Steps” docs links to the canonical docs URL prefix.
examples/stacks/rails/README.md Updates the related Ruby docs link to the canonical docs URL prefix.
examples/stacks/lepp-stack/README.md Updates related PHP/Nginx/PostgreSQL docs links to the canonical docs URL prefix.
examples/stacks/lapp-stack/README.md Updates related PHP/Apache/PostgreSQL docs links to the canonical docs URL prefix.
examples/stacks/jekyll/README.md Updates contributor quickstart + Ruby docs links to the canonical docs URL prefix.
examples/stacks/django/README.md Updates contributor quickstart + Python/PostgreSQL docs links to the canonical docs URL prefix.
examples/README.md Updates contributor quickstart link to the canonical docs URL prefix.
examples/flakes/README.md Updates “using flakes” guide link to the canonical docs URL prefix.
examples/development/ruby/README.md Updates Rails/Jekyll related docs links to the canonical docs URL prefix.
examples/development/haskell/my-project/README.md Updates Haskell docs link to the canonical docs URL prefix.
examples/data_science/tensorflow/README.md Updates quickstart install link to the canonical docs URL prefix.
examples/data_science/llama/README.md Updates quickstart install link to the canonical docs URL prefix.
examples/cloud_development/temporal/README.md Updates contributor quickstart link to the canonical docs URL prefix.

💡 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