Skip to content

[Code Quality] Document plugins configuration in frontmatter reference #14085

Description

@github-actions

Description

The plugins: configuration is fully defined in the schema and implemented in the codebase, but is completely undocumented in the user-facing frontmatter reference. Users cannot discover or properly configure this feature without reading the JSON schema directly.

Suggested Changes

Add a new section to docs/src/content/docs/reference/frontmatter.md documenting the plugins: configuration:

  1. Configuration formats:

    • Array format: plugins: ["owner/repo"]
    • Object format with custom token: plugins: { repos: ["owner/repo"], github-token: "..." }
  2. Token resolution chain:

    • github-token (frontmatter override)
    • GH_AW_PLUGINS_TOKEN environment variable
    • GH_AW_GITHUB_TOKEN environment variable
    • GITHUB_TOKEN (default)
  3. Use cases and examples:

    • Installing custom tools/extensions
    • Using private plugin repositories
    • Managing plugin authentication

Files Affected

  • docs/src/content/docs/reference/frontmatter.md (add new section)

Success Criteria

  • Documentation section added with clear examples
  • Both array and object formats documented
  • Token resolution chain explained
  • At least 2 practical examples provided
  • No other files need changes

Source

Extracted from Schema Consistency Audit discussion #14066

Original finding:

plugins: Configuration

  • Schema: Fully defined with array and object formats ✓
  • Implementation: Supported in pkg/workflow/compiler_orchestrator_tools.go
  • Documentation: Missing from docs/src/content/docs/reference/frontmatter.md
  • Impact: Users cannot discover or properly configure this feature

Priority

High - Users cannot discover this feature without reading schema files

AI generated by Discussion Task Miner - Code Quality Improvement Agent

  • expires on Feb 7, 2026, 9:12 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions