Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
persist-credentials: false

- name: Run typos checker
uses: crate-ci/typos@4d9c206a77c041268485162b8e2579ad7a5cb9a3 # v1.50.0
uses: crate-ci/typos@7f9d0819ca1c008ade73f4b41fa9d258d48f605b # v1.51.1

ci:
name: ci
Expand All @@ -44,10 +44,10 @@ jobs:
persist-credentials: false

- name: Setup pnpm
uses: pnpm/action-setup@0977fd99725f1db4007ccb2928dbb4e90d06cc86 # v6.0.10
uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0

- name: Setup node env 🏗
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
with:
cache: pnpm
node-version-file: .nvmrc
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ jobs:
persist-credentials: false

- name: Initialize CodeQL
uses: github/codeql-action/init@cdf488f595d80d6e07e03d4674febd5ab45fa938 # v4.37.9
uses: github/codeql-action/init@6f2ac81f5cd81fe351a197ba0b00d91d03cd2aee # v4.39.0
with:
languages: ${{ matrix.language }}

- name: Autobuild
uses: github/codeql-action/autobuild@cdf488f595d80d6e07e03d4674febd5ab45fa938 # v4.37.9
uses: github/codeql-action/autobuild@6f2ac81f5cd81fe351a197ba0b00d91d03cd2aee # v4.39.0

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@cdf488f595d80d6e07e03d4674febd5ab45fa938 # v4.37.9
uses: github/codeql-action/analyze@6f2ac81f5cd81fe351a197ba0b00d91d03cd2aee # v4.39.0
12 changes: 6 additions & 6 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ jobs:

- name: Setup pnpm
if: steps.cache.outputs.cache-hit != 'true'
uses: pnpm/action-setup@0977fd99725f1db4007ccb2928dbb4e90d06cc86 # v6.0.10
uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0

- name: Setup node env 🏗
if: steps.cache.outputs.cache-hit != 'true'
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
with:
cache: pnpm
node-version-file: .nvmrc
Expand All @@ -73,7 +73,7 @@ jobs:
DOCS_VERSION: ${{ matrix.version }}

- name: Upload ${{ matrix.version }} build
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: docs-${{ matrix.version }}
path: build-output
Expand All @@ -88,19 +88,19 @@ jobs:
# Stable lives at the site root; latest/patch are nested previews whose
# asset URLs already point at /latest and /patch respectively.
- name: Download stable build
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
name: docs-stable
path: dist

- name: Download latest build
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
name: docs-latest
path: dist/latest

- name: Download patch build
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
name: docs-patch
path: dist/patch
Expand Down
20 changes: 8 additions & 12 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ import { fileURLToPath, URL } from 'node:url';
import { defineConfig } from 'vitepress';
import llmstxt, { copyOrDownloadAsMarkdownButtons } from 'vitepress-plugin-llms';
import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs';
import { markdownFitMedia } from './plugins/markdown-fit-media';
import { getRedirectPaths, redirectsPlugin } from './plugins/redirects';
import { markdownFitMedia } from './plugins/markdown-fit-media.ts';
import { getRedirectPaths, redirectsPlugin } from './plugins/redirects.ts';

const redirects: Record<string, import('./plugins/redirects').RedirectValue> = {
const redirects: Record<string, import('./plugins/redirects.ts').RedirectValue> = {
// Simple redirects (1:1 moves)
'usage-guides/historical-events': '/usage-guides/history/events',
'usage-guides/onchain': '/usage-guides/history/onchain',
Expand Down Expand Up @@ -115,8 +115,8 @@ function stableCanonical(relativePath: string): string {
}

// Version switcher entries. The current build is shown as the dropdown label;
// the other two are listed as cross-links so every build — including the
// bugfixes/patch one — can reach the others.
// the other two are listed as cross-links so every build, including the
// bugfixes/patch one, can reach the others.
const currentVersion = isLatest || isPatch ? DOCS_VERSION : 'stable';
const VERSIONS = [
{ id: 'stable', text: 'Stable', link: 'https://docs.rotki.com/' },
Expand All @@ -139,13 +139,9 @@ export default defineConfig({
sitemap: base === '/'
? { hostname: STABLE_HOSTNAME }
: undefined,
// Bing flags duplicate titles/content from two sources: GitHub Pages serves
// every page at both `/foo` and `/foo.html`, and the 'latest'/'patch'
// previews re-render the same pages under their own URL trees. Emit a
// self-referencing canonical on every build (pointing at the one clean stable
// URL, matching the sitemap) so the `/foo` vs `/foo.html` pair collapses; on
// previews the same canonical points back to the stable twin. Previews
// additionally carry noindex so they drop out of the index entirely.
// Bing flags duplicates from `/foo` vs `/foo.html` and from the 'latest'/'patch'
// previews. Every build points its canonical at the clean stable URL, which
// collapses both; previews also carry noindex.
transformPageData(pageData) {
pageData.frontmatter.head ??= [];
pageData.frontmatter.head.push(
Expand Down
1 change: 1 addition & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export default rotki({
typescript: true,
markdown: true,
formatters: true,
slop: true,
}, {
files: ['shims-vue.d.ts'],
rules: {
Expand Down
33 changes: 17 additions & 16 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@rotki/docs",
"version": "1.0.0",
"private": true,
"packageManager": "pnpm@12.1.0",
"packageManager": "pnpm@12.14.0",
"description": "rotki's user guide and facing documentation",
"type": "module",
"keywords": [
Expand Down Expand Up @@ -30,27 +30,28 @@
"prepare": "husky"
},
"dependencies": {
"@vitejs/plugin-vue": "6.0.8",
"vue": "3.5.42"
"@vitejs/plugin-vue": "6.0.10",
"vue": "3.5.44"
},
"devDependencies": {
"@rotki/eslint-config": "8.3.0",
"@rotki/eslint-plugin": "1.8.0",
"@types/node": "24.13.3",
"@vue/compiler-sfc": "3.5.42",
"@vue/runtime-dom": "3.5.42",
"@rotki/eslint-config": "8.4.1",
"@rotki/eslint-plugin": "1.10.0",
"@types/node": "24.19.2",
"@vue/compiler-sfc": "3.5.44",
"@vue/runtime-dom": "3.5.44",
"cheerio": "1.2.0",
"eslint": "10.9.1",
"eslint-plugin-tsdoc": "0.5.2",
"eslint": "10.12.0",
"eslint-plugin-slop": "0.1.3",
"eslint-plugin-tsdoc": "0.5.4",
"husky": "9.1.7",
"image-size": "2.0.2",
"lint-staged": "17.4.1",
"markdown-it": "14.3.1",
"oxc-minify": "0.148.0",
"image-size": "2.0.4",
"lint-staged": "17.6.0",
"markdown-it": "14.3.2",
"oxc-minify": "0.154.0",
"papaparse": "5.7.0",
"url": "0.11.4",
"vitepress": "2.0.0-alpha.19",
"vitepress-plugin-llms": "1.13.5",
"vitepress": "2.0.0-alpha.20",
"vitepress-plugin-llms": "1.14.0",
"vitepress-plugin-tabs": "0.9.1"
},
"engines": {
Expand Down
Loading
Loading