From d4286319b47a8127af6d67ae1491403af2070d83 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 2 May 2025 12:18:37 +0200 Subject: [PATCH 1/2] Update navigation.md with cross_links docs This adds documentation on the cross_links directive in docset.yml files. --- docs/configure/content-set/navigation.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/configure/content-set/navigation.md b/docs/configure/content-set/navigation.md index c2bd4ae4b..ed75d5de7 100644 --- a/docs/configure/content-set/navigation.md +++ b/docs/configure/content-set/navigation.md @@ -59,6 +59,25 @@ external_hosts: - github.com ``` +### `cross_links` + +Defines repositories that contain documentation sets you want to link to. The purpose of this feature is to avoid using absolute links that require time-consuming crawling and checking. + +Consider an docset repository called `bazinga`. The following example adds three docset repositories to its `docset.yml` file: + +```yaml +cross_links: + - apm-server + - cloud + - docs-content +``` + +To link to a document in the `docs-content` repository, you would write the link as follows: + +``` +[Link to docs-content doc](docs-content://directory/another-directory/file.md) +``` + ### `exclude` Files to exclude from the TOC. Supports glob patterns. From 15c4cf53a447ca4db05559725b66b947c3bc70d2 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 2 May 2025 12:19:54 +0200 Subject: [PATCH 2/2] Update navigation.md --- docs/configure/content-set/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configure/content-set/navigation.md b/docs/configure/content-set/navigation.md index ed75d5de7..318a32804 100644 --- a/docs/configure/content-set/navigation.md +++ b/docs/configure/content-set/navigation.md @@ -63,7 +63,7 @@ external_hosts: Defines repositories that contain documentation sets you want to link to. The purpose of this feature is to avoid using absolute links that require time-consuming crawling and checking. -Consider an docset repository called `bazinga`. The following example adds three docset repositories to its `docset.yml` file: +Consider a docset repository called `bazinga`. The following example adds three docset repositories to its `docset.yml` file: ```yaml cross_links: