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
52 changes: 52 additions & 0 deletions .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Docs build

on:
pull_request:
paths:
- 'documentation/**'
- '.github/workflows/docs-build.yml'
branches: [ master ]
push:
paths:
- 'documentation/**'
- '.github/workflows/docs-build.yml'
branches: [ master ]
workflow_dispatch:

permissions:
contents: read

env:
# Corepack's signature check can fail to download newer pnpm on CI images;
# documented workaround. The pnpm version is still integrity-pinned by the
# sha512 hash in documentation/package.json "packageManager".
COREPACK_INTEGRITY_KEYS: "0"

jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 15

defaults:
run:
working-directory: documentation

steps:
- name: Checkout
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
persist-credentials: false

- name: Setup Node
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with:
node-version-file: documentation/.nvmrc

- name: Enable Corepack
run: corepack enable

- name: Install dependencies (frozen lockfile)
run: pnpm install --frozen-lockfile

- name: Build documentation
run: pnpm build
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ repos:
rev: v2.2.4
hooks:
- id: codespell
args: [--skip, "*.json,*.lock"]
args: [--skip, "*.json,*.lock,*pnpm-lock.yaml"]
- repo: https://github.com/PyCQA/docformatter
rev: v1.7.5
hooks:
Expand Down
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,20 +148,21 @@ When contributing to the documentation, you can run the documentation locally an
- [Node.js](https://nodejs.org/en/download/)

#### Setting Up
1. Navigate to the `docs` directory:
1. Navigate to the `documentation` directory:
```bash
cd documentation
```
2. Install the dependencies:
2. Enable [Corepack](https://nodejs.org/api/corepack.html) (provides the pinned pnpm version) and install the dependencies:
```bash
npm install
corepack enable
pnpm install
```

#### Running the Documentation Live

You can run the documentation live using the following command:
```bash
npm run start
pnpm start
```

### Linting and Formatting
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ install-develop:

# docs
docs-dev:
@cd documentation && yarn start
@cd documentation && corepack pnpm start

# docker
docker-build-client:
Expand Down
3 changes: 1 addition & 2 deletions documentation/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,4 @@
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
26 changes: 11 additions & 15 deletions documentation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "3.9.1",
"@docusaurus/preset-classic": "3.9.1",
"@docusaurus/theme-mermaid": "3.9.1",
"@inkeep/cxkit-docusaurus": "0.5.100",
"@docusaurus/core": "3.10.1",
"@docusaurus/preset-classic": "3.10.1",
"@docusaurus/theme-mermaid": "3.10.1",
"@inkeep/cxkit-docusaurus": "0.5.119",
"@mdx-js/react": "3.1.1",
"axios": "1.12.2",
"axios": "1.18.1",
"clsx": "2.1.1",
"docusaurus-plugin-sass": "0.2.6",
"micromatch": "^4.0.8",
"prism-react-renderer": "2.3.1",
"react": "18.3.1",
"react-dom": "18.3.1",
"sass": "1.93.2"
"prism-react-renderer": "2.4.1",
"react": "19.2.7",
"react-dom": "19.2.7",
"sass": "1.101.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.9.1"
"@docusaurus/module-type-aliases": "3.10.1"
},
"browserslist": {
"production": [
Expand All @@ -46,9 +46,5 @@
"engines": {
"node": ">=20.0"
},
"overrides": {
"got": "11.8.5",
"trim": "0.0.3"
},
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
"packageManager": "pnpm@11.9.0+sha512.bd682d5d03fe525ef7c9fd6780c6884d1e756ac4c9c9fe00c538782824310dcf90e3ddc4f53835f06dfaebd5085e41855e0bcbb3b60de2ac5bbab89e5036f03b"
}
Loading
Loading