From 9a000c3290aee3b4c14f30b6c7f8ffd210dc9db8 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 10 Jul 2025 15:44:38 -0700 Subject: [PATCH] Clarify mandatory link text I unwittingly hit this with no errors in the PR builds, so worth calling out IMO. --- docs/syntax/links.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/syntax/links.md b/docs/syntax/links.md index 90f4f77be..1cf04f8c8 100644 --- a/docs/syntax/links.md +++ b/docs/syntax/links.md @@ -89,7 +89,8 @@ The syntax follows the format `://`, where: - `path`: The file path within that repository :::{important} -The `path` in cross-repo links must be relative to the `docset.yml` file and not the full path within the repo +- The `path` in cross-repo links must be relative to the `docset.yml` file and not the full path within the repo. +- The link text is mandatory; if you omit it, the link will fail to be displayed. ::: Never use a full URL for links across documentation repositories.