From 517cdb32d18f50f05b011da43e027f09917572d0 Mon Sep 17 00:00:00 2001 From: Christophe Dervieux Date: Thu, 9 Apr 2026 13:28:00 +0200 Subject: [PATCH 1/7] update docs for chromium deprecation and chrome-headless-shell Reflect changes from quarto-cli#14335 (v1.9 backport): - Mark `quarto install chromium` as deprecated (was "legacy") - Add Chrome Headless Shell to quarto check sample outputs - Update quarto list tools sample with current tool names - Refresh stale version numbers in sample outputs - Note arm64 Linux support in chrome-headless-shell - Fix malformed path in troubleshooting quarto check sample --- .claude/rules/quarto-web-workflow.md | 13 +++++++++++++ bug-reports.qmd | 27 ++++++++++++++------------- docs/authoring/diagrams.qmd | 13 ++++++++++--- docs/cli/includes/_cli-commands.md | 6 +++--- docs/cli/includes/_install.md | 6 ++++-- docs/cli/includes/_uninstall.md | 4 ++-- docs/cli/includes/_update.md | 6 ++++-- docs/output-formats/pdf-engine.qmd | 8 +++++--- docs/projects/binder.qmd | 2 +- docs/troubleshooting/index.qmd | 27 +++++++++++++-------------- 10 files changed, 69 insertions(+), 43 deletions(-) create mode 100644 .claude/rules/quarto-web-workflow.md diff --git a/.claude/rules/quarto-web-workflow.md b/.claude/rules/quarto-web-workflow.md new file mode 100644 index 0000000000..a535b8869b --- /dev/null +++ b/.claude/rules/quarto-web-workflow.md @@ -0,0 +1,13 @@ +# quarto-web Workflow + +## Stable → Prerelease + +1. PRs target `main` (stable/released docs) +2. On merge, `port-to-prerelease.yml` (korthout/backport-action) auto-creates a cherry-pick PR to `prerelease` +3. Prerelease-specific changes (e.g., v1.10 features) are layered in a follow-up PR after the backport merges + +Always PR to `main` first for shared content. Never PR directly to `prerelease` for changes that apply to both stable and prerelease. + +## Remotes + +Push PR branches to `upstream` (quarto-dev/quarto-web), not `origin`. diff --git a/bug-reports.qmd b/bug-reports.qmd index 1d49561170..53a1e97265 100644 --- a/bug-reports.qmd +++ b/bug-reports.qmd @@ -100,25 +100,26 @@ For instance, the markdown code you would provide might look like this: ````md ```bash -Quarto 1.5.42 +Quarto 1.9.37 [✓] Checking versions of quarto binary dependencies... - Pandoc version 3.2.0: OK + Pandoc version 3.4.0: OK Dart Sass version 1.70.0: OK - Deno version 1.41.0: OK + Deno version 1.46.3: OK Typst version 0.11.0: OK [✓] Checking versions of quarto dependencies......OK [✓] Checking Quarto installation......OK - Version: 1.5.42 + Version: 1.9.37 Path: /Applications/quarto/bin [✓] Checking tools....................OK - TinyTeX: v2024.03.13 + TinyTeX: v2026.04 Chromium: (not installed) + Chrome Headless Shell: (not installed) [✓] Checking LaTeX....................OK Using: TinyTex Path: /Users/username/Library/TinyTeX/bin/universal-darwin - Version: 2024 + Version: 2026 [✓] Checking basic markdown render....OK @@ -126,18 +127,18 @@ Quarto 1.5.42 Version: 3.12.1 Path: /.venv/bin/python3 Jupyter: 5.7.2 - Kernels: julia-1.10, python3 + Kernels: python3 [✓] Checking Jupyter engine render....OK [✓] Checking R installation...........OK - Version: 4.3.3 - Path: /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources + Version: 4.4.2 + Path: /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources LibPaths: - - /Users/username/Library/R/arm64/4.3/library - - /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library - knitr: 1.45 - rmarkdown: 2.26 + - /Users/username/Library/R/arm64/4.4/library + - /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/library + knitr: 1.49 + rmarkdown: 2.29 [✓] Checking Knitr engine render......OK ``` diff --git a/docs/authoring/diagrams.qmd b/docs/authoring/diagrams.qmd index 4c50090e49..1e0faa5efc 100644 --- a/docs/authoring/diagrams.qmd +++ b/docs/authoring/diagrams.qmd @@ -246,8 +246,15 @@ quarto install chrome-headless-shell [Chrome Headless Shell](https://developer.chrome.com/blog/chrome-headless-shell) is a lightweight, headless-only browser from Google's [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing) infrastructure. It has fewer system dependencies than full Chromium, making it a good fit for Docker containers and WSL environments. -::: callout-note -## Legacy Chromium +::: callout-warning +## Chromium (Deprecated) + +The `quarto install chromium` command is deprecated as of Quarto 1.9. It still works but displays a deprecation warning. To migrate to Chrome Headless Shell, run: + +``` {.bash filename="Terminal"} +quarto uninstall chromium +quarto install chrome-headless-shell +``` -The older `quarto install chromium` command (which installs Chromium via Puppeteer) is still available but no longer recommended. If you use it, note that the Puppeteer-bundled Chromium may not work in Docker or WSL — see [Puppeteer troubleshooting](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#running-puppeteer-in-docker) for details. +The Puppeteer-bundled Chromium installed by the old command may not work in Docker or WSL — see [Puppeteer troubleshooting](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#running-puppeteer-in-docker) for details. Chrome Headless Shell does not have these limitations and also supports arm64 Linux. ::: diff --git a/docs/cli/includes/_cli-commands.md b/docs/cli/includes/_cli-commands.md index cb345f6e55..6c84aeb901 100644 --- a/docs/cli/includes/_cli-commands.md +++ b/docs/cli/includes/_cli-commands.md @@ -6,15 +6,15 @@ |[create](create.qmd)|Create a Quarto project or extension | |[use](use.qmd)|Automate document or project setup tasks. | |[add](add.qmd)|Add an extension to this folder or project | -|[update](update.qmd)|Updates an extension or global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). | +|[update](update.qmd)|Updates an extension or global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). | |[remove](remove.qmd)|Removes an extension. | |[convert](convert.qmd)|Convert documents to alternate representations. | |[pandoc](pandoc.qmd)|Run the version of Pandoc embedded within Quarto. | |[typst](typst.qmd)|Run the version of Typst embedded within Quarto. | |[run](run.qmd)|Run a TypeScript, R, Python, or Lua script. | |[list](list.qmd)|Lists an extension or global dependency. | -|[install](install.qmd)|Installs a global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). | -|[uninstall](uninstall.qmd)|Uninstalls a global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). | +|[install](install.qmd)|Installs a global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). | +|[uninstall](uninstall.qmd)|Uninstalls a global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). | |[tools](tools.qmd)|Display the status of Quarto installed dependencies | |[publish](publish.qmd)|Publish a document or project to a provider. | |[capabilities](capabilities.qmd)|Query for current capabilities (formats, engines, kernels etc.) | diff --git a/docs/cli/includes/_install.md b/docs/cli/includes/_install.md index 8ac37dd910..0a196cada7 100644 --- a/docs/cli/includes/_install.md +++ b/docs/cli/includes/_install.md @@ -1,4 +1,4 @@ -Installs a global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). +Installs a global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). ``` {.bash} quarto install [target...] @@ -99,12 +99,14 @@ quarto install tinytex quarto install chrome-headless-shell ``` -### Install Chromium (legacy) +### Install Chromium (deprecated) ``` {.bash filename='Terminal'} quarto install chromium ``` +Deprecated as of Quarto 1.9. Use `quarto install chrome-headless-shell` instead. + ### Choose tool to install ``` {.bash filename='Terminal'} diff --git a/docs/cli/includes/_uninstall.md b/docs/cli/includes/_uninstall.md index f939441cc2..544de21feb 100644 --- a/docs/cli/includes/_uninstall.md +++ b/docs/cli/includes/_uninstall.md @@ -1,4 +1,4 @@ -Uninstalls a global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). +Uninstalls a global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). ``` {.bash} quarto uninstall [tool] @@ -99,7 +99,7 @@ quarto uninstall tinytex quarto uninstall chrome-headless-shell ``` -### Uninstall Chromium (legacy) +### Uninstall Chromium (deprecated) ``` {.bash filename='Terminal'} quarto uninstall chromium diff --git a/docs/cli/includes/_update.md b/docs/cli/includes/_update.md index 1c522b22ff..0b306ed5c0 100644 --- a/docs/cli/includes/_update.md +++ b/docs/cli/includes/_update.md @@ -1,4 +1,4 @@ -Updates an extension or global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). +Updates an extension or global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). ``` {.bash} quarto update [target...] @@ -117,12 +117,14 @@ quarto update tool tinytex quarto update tool chrome-headless-shell ``` -### Update Chromium (legacy) +### Update Chromium (deprecated) ``` {.bash filename='Terminal'} quarto update tool chromium ``` +Deprecated as of Quarto 1.9. Use `quarto update tool chrome-headless-shell` instead. + ### Choose tool to update ``` {.bash filename='Terminal'} diff --git a/docs/output-formats/pdf-engine.qmd b/docs/output-formats/pdf-engine.qmd index 5caf2cb362..ed3ae45955 100644 --- a/docs/output-formats/pdf-engine.qmd +++ b/docs/output-formats/pdf-engine.qmd @@ -44,9 +44,11 @@ which will provide a list of available tools, the installed versions, and the la ``` bash [✓] Inspecting tools -Tool Status Installed Latest -chromium Not installed --- 869685 -tinytex Up to date v2022.10 v2022.10 +Tool Status Installed Latest +chrome-headless-shell Not installed --- 147.0.7727.56 +chromium Not installed --- 869685 +tinytex Up to date v2026.04 v2026.04 +verapdf Not installed --- 1.28.2 ``` To update to the latest version, use the command: diff --git a/docs/projects/binder.qmd b/docs/projects/binder.qmd index eba3283873..c748313272 100644 --- a/docs/projects/binder.qmd +++ b/docs/projects/binder.qmd @@ -116,7 +116,7 @@ The following files may be generated by the `quarto use binder` command. Note th `postBuild` -: The post build script runs code after restoring the environment. This script is generated with commands required to ensure the proper version of Quarto is present in the environment, install any required tools like TinyTex or Chromium, and to configure VSCode and the Quarto extension for VSCode when applicable. +: The post build script runs code after restoring the environment. This script is generated with commands required to ensure the proper version of Quarto is present in the environment, install any required tools like TinyTeX or Chrome Headless Shell, and to configure VSCode and the Quarto extension for VSCode when applicable. `apt.txt` diff --git a/docs/troubleshooting/index.qmd b/docs/troubleshooting/index.qmd index cc8bd16323..4017896461 100644 --- a/docs/troubleshooting/index.qmd +++ b/docs/troubleshooting/index.qmd @@ -13,9 +13,7 @@ but this page might help you get up and running quickly. You can check the version of Quarto and its dependencies by running `quarto check`. Here's an example of the output it generates: ``` -Quarto 1.6.30 -[✓] Checking environment information... - Quarto cache location: /Users/cscheid/Library/Caches/quarto +Quarto 1.9.37 [✓] Checking versions of quarto binary dependencies... Pandoc version 3.4.0: OK Dart Sass version 1.70.0: OK @@ -23,17 +21,18 @@ Quarto 1.6.30 Typst version 0.11.0: OK [✓] Checking versions of quarto dependencies......OK [✓] Checking Quarto installation......OK - Version: 1.6.30 - Path: /Users/cscheid/repos/github/cscheid/quarto-regress/releases/v1.6.30/binQuarto 1.5.42 + Version: 1.9.37 + Path: /Applications/quarto/bin [✓] Checking tools....................OK - TinyTeX: v2024.03.13 + TinyTeX: v2026.04 Chromium: (not installed) + Chrome Headless Shell: (not installed) [✓] Checking LaTeX....................OK Using: TinyTex Path: /Users/username/Library/TinyTeX/bin/universal-darwin - Version: 2024 + Version: 2026 [✓] Checking basic markdown render....OK @@ -41,18 +40,18 @@ Quarto 1.6.30 Version: 3.12.1 Path: /.venv/bin/python3 Jupyter: 5.7.2 - Kernels: julia-1.10, python3 + Kernels: python3 [✓] Checking Jupyter engine render....OK [✓] Checking R installation...........OK - Version: 4.3.3 - Path: /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources + Version: 4.4.2 + Path: /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources LibPaths: - - /Users/username/Library/R/arm64/4.3/library - - /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library - knitr: 1.45 - rmarkdown: 2.26 + - /Users/username/Library/R/arm64/4.4/library + - /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/library + knitr: 1.49 + rmarkdown: 2.29 [✓] Checking Knitr engine render......OK ``` From aa941641f7a109106c332419811068c29f4254da Mon Sep 17 00:00:00 2001 From: Christophe Dervieux Date: Thu, 9 Apr 2026 13:35:56 +0200 Subject: [PATCH 2/7] remove remote config from shared rules file Remote convention is local to the contributor, not a project rule. --- .claude/rules/quarto-web-workflow.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/.claude/rules/quarto-web-workflow.md b/.claude/rules/quarto-web-workflow.md index a535b8869b..69c2c8e153 100644 --- a/.claude/rules/quarto-web-workflow.md +++ b/.claude/rules/quarto-web-workflow.md @@ -8,6 +8,3 @@ Always PR to `main` first for shared content. Never PR directly to `prerelease` for changes that apply to both stable and prerelease. -## Remotes - -Push PR branches to `upstream` (quarto-dev/quarto-web), not `origin`. From d12fa3fd9382e758315f00bd4d9ab667ff2bd8bf Mon Sep 17 00:00:00 2001 From: Christophe Dervieux Date: Thu, 9 Apr 2026 13:37:19 +0200 Subject: [PATCH 3/7] note chromium will be removed in a future release --- docs/authoring/diagrams.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/authoring/diagrams.qmd b/docs/authoring/diagrams.qmd index 1e0faa5efc..3bf6591e2d 100644 --- a/docs/authoring/diagrams.qmd +++ b/docs/authoring/diagrams.qmd @@ -249,7 +249,7 @@ quarto install chrome-headless-shell ::: callout-warning ## Chromium (Deprecated) -The `quarto install chromium` command is deprecated as of Quarto 1.9. It still works but displays a deprecation warning. To migrate to Chrome Headless Shell, run: +The `quarto install chromium` command is deprecated as of Quarto 1.9 and will be removed in a future release. It still works but displays a deprecation warning. To migrate to Chrome Headless Shell, run: ``` {.bash filename="Terminal"} quarto uninstall chromium From 446abd2056c3b9753a5f2e09ee8277fd7b8fe971 Mon Sep 17 00:00:00 2001 From: Christophe Dervieux Date: Thu, 9 Apr 2026 13:39:36 +0200 Subject: [PATCH 4/7] add CLAUDE.md noting CLI includes are auto-generated --- docs/cli/includes/CLAUDE.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/cli/includes/CLAUDE.md diff --git a/docs/cli/includes/CLAUDE.md b/docs/cli/includes/CLAUDE.md new file mode 100644 index 0000000000..945295d14f --- /dev/null +++ b/docs/cli/includes/CLAUDE.md @@ -0,0 +1,16 @@ +# CLI Reference Includes + +Files in this directory are **auto-generated**. Do not edit manually. + +## Regeneration workflow + +1. Update JSON from quarto CLI source: + ```bash + quarto dev-call cli-info > docs/cli/cli-info.json + ``` +2. Regenerate markdown includes: + ```bash + quarto run _tools/reference-cli-generate-md.R + ``` + +The descriptions (e.g., tool lists in install/update/uninstall) come from quarto-cli's command definitions. To change them permanently, update the CLI source in quarto-cli. From 9bb92a4e4792bc7b9634a54bf063d446926d81dc Mon Sep 17 00:00:00 2001 From: Christophe Dervieux Date: Thu, 9 Apr 2026 13:53:50 +0200 Subject: [PATCH 5/7] regenerate CLI reference from v1.9.37 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replace manual edits with output from reference-cli-generate-md.R using quarto v1.9.37 cli-info. The v1.9 CLI source uses "legacy" in example headings (not "deprecated") — the deprecated label is only in the runtime warning, not the CLI metadata. --- docs/cli/cli-info.json | 4 ++-- docs/cli/includes/_cli-commands.md | 6 +++--- docs/cli/includes/_install.md | 6 ++---- docs/cli/includes/_uninstall.md | 4 ++-- docs/cli/includes/_update.md | 6 ++---- 5 files changed, 11 insertions(+), 15 deletions(-) diff --git a/docs/cli/cli-info.json b/docs/cli/cli-info.json index e8fee7dcae..69d2760fb2 100644 --- a/docs/cli/cli-info.json +++ b/docs/cli/cli-info.json @@ -1,5 +1,5 @@ { - "version": "1.9.36", + "version": "1.9.37", "commands": [ { "name": "render", @@ -361,7 +361,7 @@ { "name": "preview", "hidden": false, - "description": "Render and preview a document or website project.\n\nAutomatically reloads the browser when input files or document resources (e.g. CSS) change.\n\nFor website preview, the most recent execution results of computational documents are used to render\nthe site (this is to optimize startup time). If you want to perform a full render prior to\npreviewing pass the --render option with \"all\" or a comma-separated list of formats to render.\n\nFor document preview, input file changes will result in a re-render (pass --no-watch to prevent).\n\nYou can also include arbitrary command line arguments to be forwarded to \u001b[1mquarto render\u001b[22m.", + "description": "Render and preview a document or website project.\n\nAutomatically reloads the browser when input files or document resources (e.g. CSS) change.\n\nFor website preview, the most recent execution results of computational documents are used to render\nthe site (this is to optimize startup time). If you want to perform a full render prior to\npreviewing pass the --render option with \"all\" or a comma-separated list of formats to render.\n\nFor document preview, input file changes will result in a re-render (pass --no-watch to prevent).\n\nYou can also include arbitrary command line arguments to be forwarded to quarto render.", "options": [ { "standalone": true, diff --git a/docs/cli/includes/_cli-commands.md b/docs/cli/includes/_cli-commands.md index 6c84aeb901..cb345f6e55 100644 --- a/docs/cli/includes/_cli-commands.md +++ b/docs/cli/includes/_cli-commands.md @@ -6,15 +6,15 @@ |[create](create.qmd)|Create a Quarto project or extension | |[use](use.qmd)|Automate document or project setup tasks. | |[add](add.qmd)|Add an extension to this folder or project | -|[update](update.qmd)|Updates an extension or global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). | +|[update](update.qmd)|Updates an extension or global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). | |[remove](remove.qmd)|Removes an extension. | |[convert](convert.qmd)|Convert documents to alternate representations. | |[pandoc](pandoc.qmd)|Run the version of Pandoc embedded within Quarto. | |[typst](typst.qmd)|Run the version of Typst embedded within Quarto. | |[run](run.qmd)|Run a TypeScript, R, Python, or Lua script. | |[list](list.qmd)|Lists an extension or global dependency. | -|[install](install.qmd)|Installs a global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). | -|[uninstall](uninstall.qmd)|Uninstalls a global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). | +|[install](install.qmd)|Installs a global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). | +|[uninstall](uninstall.qmd)|Uninstalls a global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). | |[tools](tools.qmd)|Display the status of Quarto installed dependencies | |[publish](publish.qmd)|Publish a document or project to a provider. | |[capabilities](capabilities.qmd)|Query for current capabilities (formats, engines, kernels etc.) | diff --git a/docs/cli/includes/_install.md b/docs/cli/includes/_install.md index 0a196cada7..8ac37dd910 100644 --- a/docs/cli/includes/_install.md +++ b/docs/cli/includes/_install.md @@ -1,4 +1,4 @@ -Installs a global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). +Installs a global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). ``` {.bash} quarto install [target...] @@ -99,14 +99,12 @@ quarto install tinytex quarto install chrome-headless-shell ``` -### Install Chromium (deprecated) +### Install Chromium (legacy) ``` {.bash filename='Terminal'} quarto install chromium ``` -Deprecated as of Quarto 1.9. Use `quarto install chrome-headless-shell` instead. - ### Choose tool to install ``` {.bash filename='Terminal'} diff --git a/docs/cli/includes/_uninstall.md b/docs/cli/includes/_uninstall.md index 544de21feb..f939441cc2 100644 --- a/docs/cli/includes/_uninstall.md +++ b/docs/cli/includes/_uninstall.md @@ -1,4 +1,4 @@ -Uninstalls a global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). +Uninstalls a global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). ``` {.bash} quarto uninstall [tool] @@ -99,7 +99,7 @@ quarto uninstall tinytex quarto uninstall chrome-headless-shell ``` -### Uninstall Chromium (deprecated) +### Uninstall Chromium (legacy) ``` {.bash filename='Terminal'} quarto uninstall chromium diff --git a/docs/cli/includes/_update.md b/docs/cli/includes/_update.md index 0b306ed5c0..1c522b22ff 100644 --- a/docs/cli/includes/_update.md +++ b/docs/cli/includes/_update.md @@ -1,4 +1,4 @@ -Updates an extension or global dependency (TinyTeX, Chrome Headless Shell, Chromium (deprecated), VeraPDF). +Updates an extension or global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF). ``` {.bash} quarto update [target...] @@ -117,14 +117,12 @@ quarto update tool tinytex quarto update tool chrome-headless-shell ``` -### Update Chromium (deprecated) +### Update Chromium (legacy) ``` {.bash filename='Terminal'} quarto update tool chromium ``` -Deprecated as of Quarto 1.9. Use `quarto update tool chrome-headless-shell` instead. - ### Choose tool to update ``` {.bash filename='Terminal'} From 11e3ab27161a868df54a76f5ac8960038317353b Mon Sep 17 00:00:00 2001 From: Christophe Dervieux Date: Thu, 9 Apr 2026 13:56:06 +0200 Subject: [PATCH 6/7] restore path-scoped CLAUDE.md for cli includes --- docs/cli/includes/CLAUDE.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/docs/cli/includes/CLAUDE.md b/docs/cli/includes/CLAUDE.md index 945295d14f..af54dc0339 100644 --- a/docs/cli/includes/CLAUDE.md +++ b/docs/cli/includes/CLAUDE.md @@ -1,16 +1,10 @@ -# CLI Reference Includes +# CLI Reference: Auto-Generated Files -Files in this directory are **auto-generated**. Do not edit manually. +Files in this directory are auto-generated. Do not edit manually. -## Regeneration workflow +## Regeneration -1. Update JSON from quarto CLI source: - ```bash - quarto dev-call cli-info > docs/cli/cli-info.json - ``` -2. Regenerate markdown includes: - ```bash - quarto run _tools/reference-cli-generate-md.R - ``` +1. `quarto dev-call cli-info > docs/cli/cli-info.json` +2. `Rscript --vanilla _tools/reference-cli-generate-md.R` -The descriptions (e.g., tool lists in install/update/uninstall) come from quarto-cli's command definitions. To change them permanently, update the CLI source in quarto-cli. +Descriptions come from quarto-cli source. To change them permanently, update the CLI command definitions in quarto-cli. From 56f3362be488b2d8a04ab30083f15e538f7934b0 Mon Sep 17 00:00:00 2001 From: Christophe Dervieux Date: Thu, 9 Apr 2026 15:15:40 +0200 Subject: [PATCH 7/7] exclude CLAUDE.md from preview changed-files detection CLAUDE.md files are not rendered by Quarto but match the docs/**/[^_]*.md pattern, causing false entries in preview deployment comments. --- .github/workflows/preview.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml index 329188d6ae..9750fb0471 100644 --- a/.github/workflows/preview.yml +++ b/.github/workflows/preview.yml @@ -155,6 +155,8 @@ jobs: docs/reference/**/*.json docs/cli/*.json docs/**/images/*.png + files_ignore: | + **/CLAUDE.md json: true escape_json: false