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
8 changes: 8 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ Reach out to us on [Discord](https://discord.com/invite/tauri) on the [`#docs` c

Note: Dynamically generated pages will result in a 404 error until you run `pnpm build` for the first time.

### Checks before opening a PR

You can run these locally before opening a PR:

- `pnpm format:check` — Prettier formatting (auto-fix with `pnpm format`). CI runs this on every PR.
- `pnpm check` — type-checks the docs with `astro check` (the `packages/` submodules are excluded).
- `pnpm build` — full production build, including the reference/config/cli/release generators and the internal-link validator. Requires the submodules, so run `pnpm dev:setup` at least once first. This is the same build the Netlify deploy preview runs on every PR.

### Gitpod

[Allow Gitpod to open new tabs](https://www.gitpod.io/docs/configure/user-settings/browser-settings) so you immediately when the environment is done loading get a new tab popping up with the documentation.
Expand Down
24 changes: 0 additions & 24 deletions .github/workflows/assign.yml

This file was deleted.

10 changes: 9 additions & 1 deletion .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,17 @@ name: 'Check formatting'
on:
pull_request:

permissions:
contents: read

concurrency:
group: format-${{ github.ref }}
cancel-in-progress: true

jobs:
format:
runs-on: ubuntu-latest
runs-on: ubuntu-slim
timeout-minutes: 10
steps:
- name: Check out code using Git
uses: actions/checkout@v6
Expand Down
21 changes: 15 additions & 6 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,31 @@
name: 'Pull Request Labeler'

# SECURITY: runs on pull_request_target — never add a checkout of PR code here.

on:
pull_request_target:

permissions:
contents: read
pull-requests: write

concurrency:
group: labeler-${{ github.event.pull_request.number }}
cancel-in-progress: true

jobs:
add_labels:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
env:
NETLIFY_BUILD_KEY: ${{ secrets.NETLIFY_BUILD_KEY }}
runs-on: ubuntu-slim
timeout-minutes: 10
steps:
- id: label-pr
uses: actions/labeler@v4
with:
repo-token: '${{ secrets.GITHUB_TOKEN }}'

# Trigger prod netlify re-build to refresh i18n dashboard
- name: Rebuild i18n Dashboard
if: contains(steps.label-pr.outputs.all-labels, 'i18n')
env:
NETLIFY_BUILD_KEY: ${{ secrets.NETLIFY_BUILD_KEY }}
run: curl -X POST -d {} https://api.netlify.com/build_hooks/$NETLIFY_BUILD_KEY
41 changes: 0 additions & 41 deletions .github/workflows/priority.yml

This file was deleted.

62 changes: 0 additions & 62 deletions .github/workflows/status.yml

This file was deleted.

3 changes: 2 additions & 1 deletion .github/workflows/syncSponsorsData.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ on:
jobs:
sync-sponsors-data:
name: Sync Sponsors Data
runs-on: ubuntu-latest
runs-on: ubuntu-slim
timeout-minutes: 15

steps:
- name: Checkout repository
Expand Down
8 changes: 7 additions & 1 deletion astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// @ts-check
import { defineConfig } from 'astro/config';
import { defineConfig, passthroughImageService } from 'astro/config';
import starlight from '@astrojs/starlight';
import locales from './locales.json';
import starlightLinksValidator from 'starlight-links-validator';
Expand Down Expand Up @@ -530,6 +530,12 @@ export default defineConfig({
}),
],
image: {
// The PR build gate sets TAURI_DOCS_SKIP_IMAGE_OPT=true to skip sharp
// processing entirely (throwaway build). Netlify production builds keep the
// default sharp service. Do NOT key this off `CI` — Netlify sets CI=true.
...(process.env.TAURI_DOCS_SKIP_IMAGE_OPT === 'true'
? { service: passthroughImageService() }
: {}),
domains: ['tauri.app', 'images.opencollective.com', 'avatars.githubusercontent.com'],
},
markdown: {
Expand Down
3 changes: 3 additions & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[context.deploy-preview.environment]
TAURI_DOCS_SKIP_IMAGE_OPT = "true"

[[redirects]]
from = "/:locale/v1/*"
to = "https://v1.tauri.app/:locale/v1/:splat"
Expand Down
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"dev": "astro dev",
"format": "prettier -w --cache --plugin prettier-plugin-astro .",
"format:check": "prettier -c --cache --plugin prettier-plugin-astro .",
"check": "astro check",
"build:compatibility-table": "pnpm --filter compatibility-table run build",
"build:references": "pnpm --filter js-api-generator run build",
"build:releases": "pnpm --filter releases-generator run build",
Expand Down Expand Up @@ -50,5 +51,9 @@
"packageManager": "pnpm@10.34.5",
"engines": {
"pnpm": "^10.16.0"
},
"devDependencies": {
"@astrojs/check": "^0.9.9",
"typescript": "^5.9.3"
Comment on lines +54 to +57

@vasfvitor vasfvitor Jul 18, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will bump to typescript 7 later. The security note is about astro-check, currently it is only used locally

}
}
Loading
Loading