Display learn api docs using scalar (#62)

z3y50n · web-flow · commit b217c5498b69 · 2025-10-31T15:31:01.000-07:00
diff --git a/docs/graphql/index.html b/docs/graphql/index.html
@@ -5,7 +5,7 @@
   <link rel="preconnect" href="https://fonts.googleapis.com">
   <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
   <link href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:ital,wght@0,100..800;1,100..800&family=Work+Sans:ital,wght@0,100..900;1,100..900&display=swap" rel="stylesheet">
-  <link rel="icon" type="image/png" href="/images/favicon.png" sizes="32x32"/>
+  <link rel="icon" href="/images/favicon.ico" type="image/x-icon" sizes="48x48">
     <title>CodeSignal GraphQL API</title>
     <meta name="description" content="GraphQL API documentation for the most advanced technical assessment solution on the market."/>
     <link type="text/css" rel="stylesheet" href="index.css" />
diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico
diff --git a/docs/images/favicon.png b/docs/images/favicon.png
diff --git a/docs/index.html b/docs/index.html
@@ -5,7 +5,7 @@
     <link rel="preconnect" href="https://fonts.googleapis.com">
     <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
     <link href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:ital,wght@0,100..800;1,100..800&family=Work+Sans:ital,wght@0,100..900;1,100..900&display=swap" rel="stylesheet">
-    <link rel="icon" type="image/png" href="/images/favicon.png" sizes="32x32"/>
+    <link rel="icon" href="/images/favicon.ico" type="image/x-icon" sizes="48x48">
     <title>CodeSignal API for Developers</title>
     <meta name="description" content="Developer API documentation for the most advanced technical interview and assessment skills evaluation platform on the market."/>
     <link type="text/css" rel="stylesheet" href="index.css" />
@@ -25,6 +25,7 @@ <h1 class="header-title">API for Developers</h1>
             <div>
                 <a class="doc-link" href="./graphql/">GraphQL API</a>
                 <a class="doc-link" href="./webhooks/">Webhook API</a>
+                <a class="doc-link" href="./learn-api/">Learn API</a>
             </div>
         </div>
     </div>
diff --git a/docs/learn-api/index.html b/docs/learn-api/index.html
@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>CodeSignal Learn API for Developers</title>
+    <link rel="icon" href="/images/favicon.ico" type="image/x-icon" sizes="48x48">
+    <meta name="description" content="Developer API documentation for the Learn platform"/>
+  </head>
+  <body>
+    <div id="app"></div>
+    <!-- Load the Script -->
+    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
+    <script>
+      let baseServerURL;
+      if (window.location.hostname === 'localhost') {
+        baseServerURL = `http://localhost:9000`;
+      } else {
+        baseServerURL = `https://codesignal.com`;
+      }
+      Scalar.createApiReference('#app', {
+        // List of sources will allow us to add multiple versions in the future
+        sources: [
+          {
+            id: 'v1',
+            title: 'Version 1.0.0',
+            url: `${baseServerURL}/learn/api/v1/openapi`,
+          },
+        ],
+      });
+    </script>
+  </body>
+</html>
diff --git a/docs/webhooks/index.html b/docs/webhooks/index.html
@@ -4,7 +4,7 @@
     <link rel="preconnect" href="https://fonts.googleapis.com">
     <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
     <link href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:ital,wght@0,100..800;1,100..800&family=Work+Sans:ital,wght@0,100..900;1,100..900&display=swap" rel="stylesheet">
-    <link rel="icon" type="image/png" href="/images/favicon.png" sizes="32x32" />
+    <link rel="icon" href="/images/favicon.ico" type="image/x-icon" sizes="48x48">
     <title>CodeSignal Webhook API</title>
     <meta
       name="description"
