Skip to content

Commit 2fcd35a

Browse files
authored
Clarify mandatory link text (#1549)
1 parent 2aedfca commit 2fcd35a

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/syntax/links.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,8 @@ The syntax follows the format `<scheme>://<path>`, where:
8989
- `path`: The file path within that repository
9090

9191
:::{important}
92-
The `path` in cross-repo links must be relative to the `docset.yml` file and not the full path within the repo
92+
- The `path` in cross-repo links must be relative to the `docset.yml` file and not the full path within the repo.
93+
- The link text is mandatory; if you omit it, the link will fail to be displayed.
9394
:::
9495

9596
Never use a full URL for links across documentation repositories.

0 commit comments

Comments
 (0)