fix(docs): correct dist/docs/3.0.1 snapshot relative path + SKILL.md MDX bare brace#3428
Merged
Merged
Conversation
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.
Closes #3425
Summary
Two fixes for the CI-blocking
broken-linkscheck failures onmain:Snapshot path depth (
dist/docs/3.0.1/contributing/storyboard-authoring.md): The relative link tostatic/compliance/source/test-kits/substitution-observer-runner.yamlused../../(correct in the source atdocs/contributing/, which is 2 levels from repo root) but the dist snapshot nests 4 levels deep (dist/docs/3.0.1/contributing/). Fixed to../../../../static/…. This is the primary CI blocker — thebroken-linksworkflow triggers on anydist/docs/**path change andmintlify broken-linkstraverses the snapshot.MDX bare brace (
skills/call-adcp-agent/SKILL.md):{account_id, brand, operator, …}in the symptom table was not wrapped in backticks, causing acorn "Could not parse expression" when the MDX pipeline encounters it. Wrapped with backticks (consistent with adjacent rows using`{amount, currency}`and`{agent_url, id}`). Note:skills/is not currently in thebroken-linksworkflow's path triggers; this surfaced in a localmintlify broken-linksrun — included proactively.Known follow-up (not in this PR):
scripts/rewrite-dist-links.shrewrites/docs/and/schemas/absolute paths but does not handle relative../../static/paths incontributing/files. The next patch snapshot (3.0.2) will reproduce this breakage unless the script is extended or the source switches to a root-relative/absolute URL.docs/contributing/storyboard-authoring.mdis at 2 levels from repo root, so its existing../../static/…is correct. Applying../../../../to the source would break the live docs site. Only thedist/snapshot needed the deeper path.Non-breaking justification: docs-only changes — no schema, protocol, or API surface touched. The link target file exists at the corrected path (
static/compliance/source/test-kits/substitution-observer-runner.yaml).Pre-PR review:
skills/not currently in broken-links CI scope (confirmed via.github/workflows/broken-links.yml)Session: https://claude.ai/code/session_012dh24nfo6NMf42QnUi6TQQ