From d776e07ec8a67c8f29e2747ff9e5b41826d9aa83 Mon Sep 17 00:00:00 2001
From: smainz <stefan@mainz.ws>
Date: Fri, 10 May 2024 17:46:12 +0200
Subject: [PATCH] WIP: Update user guide

---
 .../docs/adding-content/repository-links.md   | 58 ++++++++++++++++++-
 1 file changed, 56 insertions(+), 2 deletions(-)

diff --git a/userguide/content/en/docs/adding-content/repository-links.md b/userguide/content/en/docs/adding-content/repository-links.md
index 237d38b87..934eec379 100644
--- a/userguide/content/en/docs/adding-content/repository-links.md
+++ b/userguide/content/en/docs/adding-content/repository-links.md
@@ -15,11 +15,65 @@ The Docsy [docs and blog layouts](/docs/adding-content/content/#adding-docs-and-
 
 This page shows you how to configure these links.
 
-Currently, Docsy supports only GitHub repository links "out of the box". Since GitLab can handle the same link scheme, it should work as well. If you are using another repository such as Bitbucket and would like generated repository links, feel free to [add a feature request or update our theme](/docs/contribution-guidelines/).
+Currently, Docsy supports GitHub, Azure de and Gitea repository links "out of the box". Since GitLab can handle the same link scheme as GitHub, it should work as well. If you are using another repository such as Bitbucket and would like generated repository links, feel free to [add a feature request or update our theme](/docs/contribution-guidelines/).
 
 ## Link configuration
 
-There are four site variables you can configure in `hugo.toml`/`hugo.yaml`/`hugo.json` to set up links, as well as one in your page metadata.
+There are a few site variables you can configure in `hugo.toml`/`hugo.yaml`/`hugo.json` to set up links, as well as one in your page metadata.
+
+{{< tabpane >}}
+{{< tab header="Configuration file:" disabled=true />}}
+{{< tab header="hugo.toml" lang="toml" >}}
+[params.repo]
+  type = "github"
+  url = "https://github.com/google/docsy"
+  subdir = "userguide"
+  branch = "release"
+  project_url = "https://github.com/google/docsy
+{{< /tab >}}
+{{< tab header="hugo.yaml" lang="yaml" >}}
+params:
+  repo:
+    type: github
+    url: https://github.com/google/docsy
+    subdir: "userguide"
+    branch: "release"
+    project_url: "https://github.com/google/docsy
+{{< /tab >}}
+{{< tab header="hugo.json" lang="json" >}}
+{
+  "params": {
+    "repo": {
+        "type": "github",
+        "url": "https://github.com/google/docsy",
+        "subdir": "userguide",
+        "branch"= "release",
+        "project_url" = "https://github.com/google/docsy
+    }
+  }
+}
+{{< /tab >}}
+{{< /tabpane >}}
+
+### `repo.type`
+
+### `repo.url`
+
+### `repo.subdir` (optional)
+
+### `repo.branch` (optional)
+
+### `repo.project_url` (optional)
+
+### Working with git submodules (`path_base_for_subdir`)
+
+## GitHub configuration (deprecated)
+
+{{% alert title="Deprecation note" color="warning" %}}
+  These setting are deprecated. Use the params described in [Link Configuration][] instead.
+
+  [Link Configuration]: #link-configuration
+{{% /alert %}}
 
 ### `github_repo`