docs: fix broken jetify.com documentation links (/devbox/docs → /docs/devbox)#2853
Open
mikeland73 wants to merge 4 commits into
Open
docs: fix broken jetify.com documentation links (/devbox/docs → /docs/devbox)#2853mikeland73 wants to merge 4 commits into
mikeland73 wants to merge 4 commits into
Conversation
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.
Contributor
There was a problem hiding this comment.
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 withhttps://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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Jetify documentation site reorganized its URL structure from
jetify.com/devbox/docs/...tojetify.com/docs/devbox/.... The old links were left behind inREADME.mdand 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 canonicalwww.jetify.com/docs/devbox/...format. The correct format is already used by the generated.envrctemplate (internal/devbox/generate/tmpl/envrc.tmpl) and the example.envrcfiles, 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/…/installing-devbox/and…/quickstart/)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/devboxsegment was touched. Image paths such as…/devbox/img/shield_galaxy.svgwere intentionally left untouched.Verification
jetify.com/devbox/docsoccurrences after the change.envrc.tmpl, example.envrcfiles).Note: the docs site is behind a WAF that returns
403to 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