fix(docs): replace stale v3 doc links with v4 equivalents#2786
Merged
Conversation
Customers following doc links from the main branch were landing on v3 (SodaCL / Soda Library) documentation and following the wrong process. - JSON contract schema: point the schema check description at the v4 contract language reference (#schema-check) instead of the v3 SodaCL page, and the threshold descriptions at #thresholds instead of the dead docs.soda.io/#thresholds anchor. Also drop two leftover 'YY ' prefixes in threshold descriptions. - exit_codes.py: the ExitCode docstring linked to the v3 Soda Library docs; no v4 page documents Soda Core exit codes (the sodacli page documents different semantics), so document the codes inline instead. The v3 links in the README's 'Working with legacy Soda Core v3' section are intentional and left as-is. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Niels-b
approved these changes
Jul 13, 2026
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
2 participants
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.
Context
A customer cloned the repo and followed a v3 docs link found on the
mainbranch, ending up on the wrong (legacy) process. This PR replaces the remaining v3-era doc links with their v4 equivalents.Changes
soda_data_contract_json_schema_1_0_0.json(user-facing via IDE validation/hover while authoring contracts):docs.soda.io/soda-cl/schema.html(v3 SodaCL) →docs.soda.io/soda-v4/reference/contract-language-reference#schema-checkdocs.soda.io/#thresholdsanchor →docs.soda.io/soda-v4/reference/contract-language-reference#thresholds"YY "prefixes in threshold descriptions.exit_codes.py:ExitCodedocstring linked to the v3 Soda Library docs (docs.soda.io/soda-library/programmatic.html#scan-exit-codes). No v4 page documents Soda Core's exit codes — thesodaclireference documents different exit-code semantics (2= execution error there, vs. check warnings here) — so the codes are now documented inline in the docstring instead.Both replacement pages/anchors were verified to exist on docs.soda.io. The v3 links in the README's clearly-labeled "Working with legacy Soda Core v3" section are intentional and left untouched.
Notes / follow-ups (not in this PR)
go.soda.ioshortlinks: no suitable shortlinks exist yet for these targets, and the closest existing ones (go.soda.io/schema,go.soda.io/contracts) still redirect to v3 pages. Once v4-targeted slugs are created (e.g.contract-schema-check,contract-thresholds), swapping them in is a trivial follow-up.🤖 Generated with Claude Code