Skip to content

[docs] Update documentation for features from 2026-06-02#36440

Closed
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/update-frontmatter-fields-2026-06-02-d13c68aa72ada51b
Closed

[docs] Update documentation for features from 2026-06-02#36440
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/update-frontmatter-fields-2026-06-02-d13c68aa72ada51b

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented Jun 2, 2026

Documentation Updates - 2026-06-02

This PR documents two frontmatter fields that existed in the JSON Schema but had no entry in the curated frontmatter reference, and aligns them with recent code changes from the last 24 hours.

Features Documented

  • check-for-updates (top-level, default true) — controls the compile-time version update check in the activation job. Previously undocumented in curated docs.
  • runtimes.<runtime>.run-install-scripts (default false) — now the only valid form for this field after the top-level variant was removed in Remove deprecated top-level run-install-scripts frontmatter field #36387. Documented under the existing Runtimes section.

Both new headings use the bare field-name slug so the in-schema anchor links (#check-for-updates, #run-install-scripts) emitted in main_workflow_schema.json descriptions now resolve to real headings.

📝 Detailed Changes & References

Changes Made

  • docs/src/content/docs/reference/frontmatter.md:
    • Added an h3 check-for-updates reference section after Strict Mode, describing the default-on activation-job version check and the strict-mode restriction.
    • Added an h4 run-install-scripts subsection inside the Runtimes section, documenting the per-runtime supply-chain install-script opt-in, its compile-time warning / strict-mode error, and noting that the removed top-level form must now be configured under a runtime block.

Triggering Code Change

Pre-existing Gap Addressed

Last-24h merged PRs reviewed (no user-doc change required)

Skipped Issues

Notes

  • The two new headings deliberately use code-formatted bare field names (### \check-for-updates`, #### `run-install-scripts`) rather than the page's usual descriptive ### Name (`field:`)style. This is required so the heading slugs exactly match the#check-for-updates/#run-install-scriptsanchors hard-coded in the schema descriptions. If maintainers prefer descriptive headings, the alternative is a one-line update to theSee:links inpkg/parser/schemas/main_workflow_schema.json(plus a regeneration of the generatedfrontmatter-full.md`), which was kept out of scope for this docs-only run.
  • No schema or generated files were modified, so the schema-consistency check is unaffected.

Generated by 📝 Daily Documentation Updater · opus48 2.6M ·

  • expires on Jun 3, 2026, 4:09 AM UTC-08:00

…tmatter fields

Add curated reference entries for two top-/runtime-level frontmatter
fields that were previously only present in the auto-generated
frontmatter-full.md:

- check-for-updates (top-level, default true) — activation-job version check
- runtimes.<runtime>.run-install-scripts (default false) — now the only
  valid form after the top-level field was removed (#36387)

Both headings use the field-name slug so the in-schema anchor links
(#check-for-updates, #run-install-scripts) resolve to real headings,
addressing the still-present gap tracked in #36275.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Jun 2, 2026
@github-actions
Copy link
Copy Markdown
Contributor Author

github-actions Bot commented Jun 2, 2026

@copilot please rerun checks and summarize any remaining blockers.

Generated by 👨‍🍳 PR Sous Chef · gpt54 12M ·

@pelikhan pelikhan closed this Jun 2, 2026
@github-actions github-actions Bot added the closed:unknown PR was closed without merging: unknown label Jun 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation closed:unknown PR was closed without merging: unknown documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant