Update reference pages for v1.9.27

[github-actions]

Automated update of reference documentation for Quarto prerelease v1.9.27.

Summary

1 file changed, 1 insertion(+), 1 deletion(-)

Changed files

docs/cli/cli-info.json

Scripts run

• tools/reference.ts - format/cell/project reference JSON
• tools/reference-cli-generate-md.R - CLI reference markdown

[cderv]

/deploy-preview

[github-actions]

📝 Preview Deployment

🔍 Full site preview: https://deploy-preview-1929.quarto.org

[cderv]

So it is working yeah !!

Idea as I did that for others in the preview deployment workflow: I can add which pages to look at in addition to the main preview link.

I guess the cli-info.json does update pages at https://prerelease.quarto.org/docs/cli/ right?

So I could detect if cli-info.json is in the changed file and if so adds https://deploy-preview-1929.quarto.org//docs/cli/index.tml as page to link to in the comment above.

I have done that for other cases already

[cwickham]

@cderv Yes, cli-info.json along with tools/generate-reference-pages.R updates the docs/cli/includes/_xxx.md files which are then used via the include shortcode. How hard would it be to detect changes to the docs/cli/includes/_xxx.md files and give the preview link to the corresponding docs/cli/yyy.qmd page? Some pages, e.g. docs/cli/call.qmd include multiple docs/cli/includes/_xxx.md files.

The same problem occurs for the other reference pages. E.g. changes to reference/**/*.json files indirectly drive changes on reference/**/*.qmd pages and we don't get the preview links. For cells/ and formats/ and metadata/ I think the relationship between .json and .qmd is one to one. For projects/ its a bit more complicated...

[cderv]

It is not hard if what we want to do is

• Detect one of these files (like docs/cli/includes/_*.md)
• If found then show a link for this other one: like docs/cli/includes/index.html

What I did not manage efficiently to do is

• Detect change in this _*.qmd file => EASY
• But as this is a _ one then it means it has no HTML page, so find the other page where it is included... => HARD

But for reference pages, if we know whare the link to add, then I think this is easy to add.

Can you help me understand this ?