Skip to content

[Code Quality] Document engine.extensions key in frontmatter reference #46573

Description

@github-actions

Description

The engine.extensions frontmatter key is supported by the Pi engine runtime (pkg/workflow/pi_engine.go:211,240-251) and documented in the detailed engines reference, but is missing from the top-level frontmatter reference at docs/src/content/docs/reference/frontmatter.md. The file documents engine.driver (line 154) but omits engine.extensions, making the quick reference incomplete for Pi users.

Suggested Changes

  • Add a subsection for engine.extensions near engine.driver in docs/src/content/docs/reference/frontmatter.md
  • Or add an explicit cross-reference link to the Pi-specific extension documentation in the engines reference
  • Ensure Pi users can discover extension support from the frontmatter quick reference

Files Affected

  • docs/src/content/docs/reference/frontmatter.md (add engine.extensions near line 154)
  • pkg/workflow/pi_engine.go (lines 211, 240-251 — implementation reference)
  • docs/src/content/docs/reference/engines.md (lines 435-447 — detailed docs exist here)

Success Criteria

  • engine.extensions is findable from frontmatter.md
  • Documentation correctly describes the key type, supported values, and behavior
  • No inconsistency between frontmatter.md and engines.md for Pi-specific keys

Source

Extracted from Schema Consistency Check - 2026-07-19 #46539

Priority

Medium — Pi users relying on the quick frontmatter reference will miss a valid supported key

🔍 Task mining by Discussion Task Miner - Code Quality Improvement Agent · 83.8 AIC · ⌖ 5.28 AIC · ⊞ 7K ·

  • expires on Jul 19, 2026, 11:45 PM UTC-08:00

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions