santiment · serafim-san · Oct 28, 2025 · Oct 30, 2025 · Nov 13, 2025 · Nov 13, 2025
diff --git a/.docs/GUIDE.md b/.docs/GUIDE.md
@@ -0,0 +1,110 @@
+# How to write Academy articles
+
+## High-level file structure
+
+![File Structure](./file_structure.png)
+
+All pages seen on the website are located inside `src/content/docs/`.
+For example all metrics articles are located inside src/docs/metrics/, pages about
+Sanbase are inside `src/docs/guides/sanbase/`, etc.
+
+This structure is very important for the visualization. It should be created inside the most appropriate directory, or if such directory is missing - create a new directory.
+
+## Article-level file structure
+
+When creating a new article, do the following steps:
+
+- Decide on the article title. For the purpose of the example let's choose 'Trading and Transaction Volume'
+- Locate the most appropriate directory where the article
+- Create a new folder named `trading-and-transaction-volume` inside it. This directory name is important
+  and should reflect the name of the article itself. Usually it is the `snake-case` version of the title.
+  This directory name is important as we'll use it when we create links to that article.
+- Create an `index.mdx` file inside that directory. The name is important. This will be the main/index page of
+  the article.
+
+## Contents of the index.mdx file
+
+### Header
+
+Always start with the header structure, which looks like this.
+Fields `title` and `datePublished` are mandatory.
+`datePublished` field must not be update after article deploy.
+Add field `dateModified` and write any changes thee instead.
+
+```
+---
+title: Trading and Transaction Volume
+author: Santiment Team
+datePublished: 2025-05-13
+---
+```
+
+![Header fields](./title_and_date.jpg)
+
+The `title` and `dateModified` fields are displayed on the article page, as seen in the screenshot.
+
+The `title` field will be transformed to an h1 HTML tag in the final page.
+One page should have one h1 tag, holding the title. In Markdown this is usually represented
+as a line starting with `#`, like:
+
+`# Trading and Transaction Volume`.
+
+As this is done automatically by us by defining the title, we should **not** use `# title` anywhere in the article thereafter.
+
+Do not define the title second time with markdown!
+
+### Youtube Video
+
+If some video from our channel needs to be added, go to the youtube video and copy the `iframe`
+that is produced when you click Share->Embed
+![noborder](./embed_youtube_video_1.png)
+
+Paste the copied iframe right after the header definition, if you wish to have the video right after the title on the final page.
+
+### Subsections
+
+As our title is defined in the header, all main subsections are defined as:
+
+```
+## Title of subsection 1
+```
+
+These subsections are shown as h2 titles in the HTML (smaller titles than the main title).
+They are also shown in the right sidebar/map of the article.
+
+![noborder](./subsections.png)
+
+You can use `###`, `####`, etc. to further nest subsections.
+
+You should be consistent -- all top-level subsections should be `##` and the subsections of these subsections should
+be `###`, and so on.
+
+### Links and images
+
+#### Links
+
+Markdown link syntax is: `[Link Text](Link URL)`. The link URL can be:
+
+- External (link to sanbase) -- the full URL must be provided. Example: `[Sanbase](https://app.santment.net)`
+- Internal -- point to some other page of Academy. These paths are relative. Relative paths allow you to link to stage
+  pages on stage and to prod pages on prod. Do not use full paths when linking to other Academy pages!
+
+  Example: `[NVT article](/metrics/nvt)`. The root of the relative path is the `/src/docs/` directory.
+
+  Standard relative path syntax works: `./` points to the current directory and `../` points to the parent directory.
+
+The same rules apply to linking from other pages to your new article page.
+If our example `Trading and Transaction Volume` article is located in the `Education and Use Cases` directory, then
+the following syntax will create a link to our article: `[Trading and Transaction Volume](/education-and-use-cases/trading-and-transaction-volume/)`
+
+#### Images
+
+Markdown image syntax is `![noborder](Image path)`.
+
+In almost all cases the image file is located in the same directory as the `index.md` file. If the image `img.png` is located
+in the same directory, then the following syntax will add it `![noborder](./img.png)`. The `./` is the above-mentioned way to point
+to the current directory.
+
+Note: The `noborder` is Academy-specific and it removes borders from images. By default we prefer to not have borders.
+
+Prefer adding the images to the directory of your article instead of using images hosted on some other server.
diff --git a/docs/embed_youtube_video_1.png → .docs/embed_youtube_video_1.png b/docs/embed_youtube_video_1.png → .docs/embed_youtube_video_1.png
diff --git a/docs/file_structure.png → .docs/file_structure.png b/docs/file_structure.png → .docs/file_structure.png
diff --git a/docs/navigation.png → .docs/navigation.png b/docs/navigation.png → .docs/navigation.png
diff --git a/docs/subsections.png → .docs/subsections.png b/docs/subsections.png → .docs/subsections.png
diff --git a/docs/title_and_date.jpg → .docs/title_and_date.jpg b/docs/title_and_date.jpg → .docs/title_and_date.jpg
diff --git a/.gitignore b/.gitignore
@@ -1,86 +1,36 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
+# build output
+dist/
+public/
+public/pagefind/
 
-# nyc test coverage
-.nyc_output
+# generated types
+.astro/
 
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
+# dependencies
 node_modules/
-jspm_packages/
-
-# Typescript v1 declaration files
-typings/
 
-# Optional npm cache directory
-.npm
+#svelte
+.svelte-kit
 
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
 
-# Output of 'npm pack'
-*.tgz
+# static
+static/webkit
+static/vendors
+static/~partytown
 
-# dotenv environment variables file
+# environment variables
 .env
+.env.production
 
-# gatsby files
-.cache/
-public
-
-# Mac files
+# macOS-specific files
 .DS_Store
 
-# Yarn
-yarn-error.log
-package-lock.json
-.pnp/
-.pnp.js
-# Yarn Integrity file
-.yarn-integrity
-
+# jetbrains setting folder
 .idea/
 
-.tool-versions
-.aider*
-
-
-# web components
-
-svelte-widgets/.svelte-kit
-svelte-widgets/static/webkit
-
-# mkcert
-
-local.santiment.net.pem
-local.santiment.net-key.pem
+mkcert
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,2 @@
+./src/content/docs/**/*.md
+./src/content/docs/**/*.mdx
diff --git a/.prettierrc b/.prettierrc
@@ -3,5 +3,37 @@
   "semi": false,
   "singleQuote": true,
   "tabWidth": 2,
-  "trailingComma": "es5"
+  "trailingComma": "all",
+  "plugins": [
+    "prettier-plugin-astro",
+    "prettier-plugin-svelte",
+    "@trivago/prettier-plugin-sort-imports",
+    "prettier-plugin-tailwindcss"
+  ],
+  "importOrder": [
+    "^astro",
+    "^svelte",
+    "^san-webkit-next/(.*)$",
+    "^\\$layouts/(.*)$",
+    "^\\$components/(.*)$",
+    "^\\$modules/(.*)$",
+    "^\\$config/(.*)$",
+    "^[./]"
+  ],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true,
+  "overrides": [
+    {
+      "files": "*.astro",
+      "options": {
+        "parser": "astro"
+      }
+    },
+    {
+      "files": "*.svelte",
+      "options": {
+        "parser": "svelte"
+      }
+    }
+  ]
 }
diff --git a/Dockerfile b/Dockerfile
@@ -1,22 +1,19 @@
-FROM debian:bullseye
+FROM node:20-alpine AS base
 
-RUN apt-get update && \
-    apt-get install -y \
-        python3 \
-        python3-dev \
-        python3-pip \
-        build-essential \
-        curl git
+RUN apk add git
+RUN npm install -g pnpm@8
 
-RUN curl -fsSL https://deb.nodesource.com/setup_16.x | bash -
-RUN apt-get install -y nodejs
+ENV NODE_ENV production
 
 WORKDIR /app
 
-COPY ./ /app
+COPY package.json pnpm-lock.yaml /app
 
-ENV BACKEND_URL="globalThis.env?.BACKEND_URL"
+RUN pnpm i --ignore-scripts --frozen-lockfile --prod --force
 
-RUN npm install -g yarn --force && yarn install --production
+FROM base AS builder
+ARG BACKEND_URL
 
-RUN yarn build
+COPY . /app
+
+RUN pnpm build
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -1,15 +1,37 @@
-podTemplate(label: 'academy-builder', containers: [
-  containerTemplate(name: 'docker', image: 'docker', ttyEnabled: true, command: 'cat', envVars: [
-    envVar(key: 'DOCKER_HOST', value: 'tcp://docker-host-docker-host:2375')
-  ])
-]) {
-  node('academy-builder') {
+@Library('podTemplateLib')
+import net.santiment.utils.podTemplates
+
+properties([buildDiscarder(logRotator(artifactDaysToKeepStr: '30', artifactNumToKeepStr: '', daysToKeepStr: '30', numToKeepStr: ''))])
+
+slaveTemplates = new podTemplates()
+
+slaveTemplates.dockerTemplate { label ->
+  node(label) {
     stage('Build') {
       container('docker') {
         def scmVars = checkout scm
-        def gitHead = scmVars.GIT_COMMIT.substring(0,7)
 
-        if (env.BRANCH_NAME == "master") {
+        if (env.BRANCH_NAME == "main") {
+          withCredentials([
+            string(
+              credentialsId: 'SECRET_KEY_BASE',
+              variable: 'SECRET_KEY_BASE'
+            ),
+            string(
+              credentialsId: 'aws_account_id',
+              variable: 'aws_account_id'
+            )
+          ]) {
+            def awsRegistry = "${env.aws_account_id}.dkr.ecr.eu-central-1.amazonaws.com"
+            docker.withRegistry("https://${awsRegistry}", "ecr:eu-central-1:ecr-credentials") {
+              sh "docker build --build-arg BACKEND_URL=https://api-stage.santiment.net -t ${awsRegistry}/academy:stage -t ${awsRegistry}/academy:${scmVars.GIT_COMMIT} ."
+              sh "docker push ${awsRegistry}/academy:stage"
+              sh "docker push ${awsRegistry}/academy:${scmVars.GIT_COMMIT}"
+            }
+          }
+        }
+
+        if (env.BRANCH_NAME == "production") {
           withCredentials([
             string(
               credentialsId: 'SECRET_KEY_BASE',
@@ -22,8 +44,8 @@ podTemplate(label: 'academy-builder', containers: [
           ]) {
             def awsRegistry = "${env.aws_account_id}.dkr.ecr.eu-central-1.amazonaws.com"
             docker.withRegistry("https://${awsRegistry}", "ecr:eu-central-1:ecr-credentials") {
-              sh "docker build -t ${awsRegistry}/academy:${env.BRANCH_NAME} -t ${awsRegistry}/academy:${scmVars.GIT_COMMIT} ."
-              sh "docker push ${awsRegistry}/academy:${env.BRANCH_NAME}"
+              sh "docker build --build-arg BACKEND_URL=https://api.santiment.net -t ${awsRegistry}/academy:production -t ${awsRegistry}/academy:${scmVars.GIT_COMMIT} ."
+              sh "docker push ${awsRegistry}/academy:production"
               sh "docker push ${awsRegistry}/academy:${scmVars.GIT_COMMIT}"
             }
           }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		./src/content/docs/*/.md
		./src/content/docs/*/.mdx