docs: fix broken jetify.com documentation links in README#2859
Open
mikeland73 wants to merge 2 commits into
Open
docs: fix broken jetify.com documentation links in README#2859mikeland73 wants to merge 2 commits into
mikeland73 wants to merge 2 commits into
Conversation
The Devbox documentation moved from /devbox/docs/ to /docs/devbox/, and the contributor-quickstart page no longer exists. Update the README links so they point at the current docs structure: - cli_reference/devbox -> cli-reference/devbox (now hyphenated, under /docs/devbox) - quickstart and installing-devbox -> /docs/devbox/... - Built with Devbox badge now links to the in-repo CONTRIBUTING.md, since the hosted contributor-quickstart page was removed Fixes #2769
Contributor
There was a problem hiding this comment.
Pull request overview
Updates README.md to fix (and proactively prevent) broken Jetify Devbox documentation links after the docs site reorganization, addressing the 404s reported in #2769.
Changes:
- Replace deprecated
https://www.jetify.com/devbox/docs/...links with the new canonicalhttps://www.jetify.com/docs/devbox/...structure. - Update the CLI reference URL path from
cli_referencetocli-reference. - Point the “Built with Devbox” badge to the repo-local
CONTRIBUTING.md(which exists in-repo) instead of the removed hosted contributor quickstart page.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Previous run hit a transient HTTP 502 from the Nix binary cache (install.determinate.systems) during print-dev-env on the test-nix-versions (macos-latest, 2.19.2) job. No source changes; this empty commit re-runs CI.
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.
What
Fixes the broken/404 documentation links in
README.mdreported in #2769.The Devbox docs were reorganized: they moved from
https://www.jetify.com/devbox/docs/...tohttps://www.jetify.com/docs/devbox/..., the CLI reference path switched fromcli_reference(underscore) tocli-reference(hyphen), and the hostedcontributor-quickstartpage was removed (it isn't present in thejetify-com/docssource tree anymore).Changes
…/devbox/docs/cli_reference/devbox/…/docs/devbox/cli-reference/devbox…/devbox/docs/contributor-quickstart/(badge)CONTRIBUTING.md…/devbox/docs/quickstart/…/docs/devbox/quickstart…/devbox/docs/installing-devbox/…/docs/devbox/installing-devboxThe two links explicitly called out in the issue (
cli_reference/devboxandcontributor-quickstart) were the confirmed 404s; the other two used the same deprecated/devbox/docs/prefix and are updated to the current canonical structure to prevent future breakage. The "Built with Devbox" badge now points at the in-repoCONTRIBUTING.md, mirroring howCODE_OF_CONDUCT.mdis already linked.Notes
Docs-only change; no code paths affected.
Closes #2769
cc @pmorch (issue reporter)
Generated by Claude Code