From 8bb001f3217a2d6ca2d9536e2c2a0ea479851262 Mon Sep 17 00:00:00 2001 From: Sebastian Kawelke <kawelkesebastian@gmail.com> Date: Tue, 17 Dec 2024 14:49:05 +0100 Subject: [PATCH] Adds explanation hint to concepts Signed-off-by: Sebastian Kawelke <kawelkesebastian@gmail.com> --- src/pages/concepts/index.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/pages/concepts/index.mdx b/src/pages/concepts/index.mdx index afdb0ec..9ccfdd3 100644 --- a/src/pages/concepts/index.mdx +++ b/src/pages/concepts/index.mdx @@ -22,3 +22,9 @@ As a result, some checks are evaluated based on thresholds (e.g. the issue react To determine the thresholds, we examine the usual values of the projects on Open CoDE and derive the corresponding thresholds from their mean values and standard deviations. +### Explanation + +We encourage that you integrate the [badge explanation endpoint](/api-docs/v1/badges#get-badge-explanation) +into your application to provide a detailed explanation of the badge result to your users. + +A typical use case is to make the badge clickable and show the explanation on a detail page. \ No newline at end of file -- GitLab