Fix broken docs links in README (404s)#2840
Open
mikeland73 wants to merge 2 commits into
Open
Conversation
The docs links in README.md used the legacy `jetify.com/devbox/docs/` URL prefix, which now returns 404. The canonical docs URL structure is `jetify.com/docs/devbox/` (as already used in the generated .envrc template and example READMEs migrated in #2730). Update the contributor-quickstart, installing-devbox, quickstart, and cli_reference links accordingly. Fixes #2769
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes broken documentation links in the top-level README.md by updating legacy /devbox/docs/ URLs to the current /docs/devbox/ structure.
Changes:
- Updated four README documentation links to the canonical Jetify docs path.
- Left the Devbox product landing page link unchanged since it is not a docs URL.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- CLI reference path uses a hyphen: cli-reference (not cli_reference) - The contributor-quickstart docs page no longer exists; point the "Built with Devbox" badge to the devbox repo instead
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 documentation links in
README.mduse the legacyhttps://www.jetify.com/devbox/docs/...URL prefix, which now returns 404. The canonical docs URL structure ishttps://www.jetify.com/docs/devbox/...(thedevbox/docspath segments are swapped).This same migration was already applied to the example project READMEs in #2730, and the generated
.envrctemplate (internal/devbox/generate/tmpl/envrc.tmpl) already uses thedocs/devbox/form. The top-levelREADME.mdwas missed.Changes
Updated the four broken doc links in
README.mdto swap the prefix from/devbox/docs/→/docs/devbox/:…/devbox/docs/contributor-quickstart/…/docs/devbox/contributor-quickstart/…/devbox/docs/installing-devbox/…/docs/devbox/installing-devbox/…/devbox/docs/quickstart/…/docs/devbox/quickstart/…/devbox/docs/cli_reference/devbox/…/docs/devbox/cli_reference/devbox/The issue reported two of these (contributor-quickstart and cli_reference); the other two shared the same broken prefix and would 404 as well, so they were fixed for consistency. The product landing page link (
https://www.jetify.com/devbox/) does not use the broken/docs/path and was left unchanged.How was it tested?
Docs-only change. The corrected prefix matches the URL structure already used elsewhere in the repo (example READMEs and the
.envrctemplate).Fixes #2769
cc @pmorch (issue reporter)
Generated by Claude Code