Skip to content

docs(site): document inlined-imports field in front-matter reference#738

Merged
jamesadevine merged 1 commit into
mainfrom
docs/front-matter-inlined-imports-1382d53790ee9a28
May 24, 2026
Merged

docs(site): document inlined-imports field in front-matter reference#738
jamesadevine merged 1 commit into
mainfrom
docs/front-matter-inlined-imports-1382d53790ee9a28

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

  • Users can now discover the inlined-imports: field directly from the front-matter reference page — previously it was documented only in the source-level docs/front-matter.md, invisible to site readers.
  • The field controls whether {{#runtime-import ...}} markers are resolved at compile time or at pipeline runtime; this is a real authoring trade-off that wasn't discoverable from the site.

Changes

  • site/src/content/docs/reference/front-matter.mdx:
    • Add inlined-imports: commented line to the annotated example YAML block (near env:, in front-matter field sequence).
    • Add ## Inlined Imports section (after Repos / Legacy syntax, before Filter Validation) explaining the false/true trade-offs and linking to the Runtime Imports reference page.

Accuracy checks

  • inlined-imports field confirmed in src/compile/types.rs (#[serde(rename = "inlined-imports", default)]).
  • Behavior description (compile-time vs runtime resolution, self-contained YAML, prompt edit cost) cross-checked against docs/front-matter.md and docs/runtime-imports.md.

Validation

  • cd site && npm ci && npm run build — 29 pages built, all internal links valid.

Created by the docs-writer workflow.

Generated by Docs Writer · ● 11.2M ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jamesadevine jamesadevine marked this pull request as ready for review May 24, 2026 15:27
@jamesadevine jamesadevine merged commit 8d0be09 into main May 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant