Skip to content

Clarify mandatory link text #1549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2025
Merged

Clarify mandatory link text #1549

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/syntax/links.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@ The syntax follows the format `<scheme>://<path>`, 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.
Expand Down
Loading