Skip to content

docs: add executor to getting started manifest#435

Merged
spboyer merged 1 commit into
mainfrom
spboyer-fix-getting-started-manifest
Jul 14, 2026
Merged

docs: add executor to getting started manifest#435
spboyer merged 1 commit into
mainfrom
spboyer-fix-getting-started-manifest

Conversation

@spboyer

@spboyer spboyer commented Jul 14, 2026

Copy link
Copy Markdown
Member

Summary

The Getting Started eval.yaml example omitted the required config.executor field, so copied manifests did not conform to the schema. Add executor: mock to make the starter manifest valid without requiring API access.

Related issue

Closes #436

Agent handoff

  • Scope: Correct the published getting-started eval manifest.
  • Key files changed: site/src/content/docs/getting-started.mdx
  • Important decisions: Use mock, matching the repository's existing getting-started and example manifests.
  • Follow-ups or known gaps: None.

Type of change

  • Bug fix
  • New feature
  • Documentation update
  • Refactor or maintenance
  • CI/CD or release change

Validation

  • go test ./...
  • make lint or golangci-lint run
  • Docs site checked, if docs changed
  • Web/dashboard checks run, if web/ changed
  • Manual validation completed: Confirmed the manifest includes config.executor.
  • Not applicable; reason: No Go or web/dashboard code changed.

Documentation

  • README updated, if user-facing behavior changed
  • site/ docs updated, if CLI, YAML, dashboard, or validator behavior changed
  • Examples updated, if relevant
  • Not applicable

Risk and rollback

  • Risk level: Low
  • Rollback plan: Revert the single documentation line.

Notes for reviewers

No behavior changes; verify the starter manifest remains aligned with the eval schema.

Co-authored-by: Copilot App <[email protected]>

Copilot-Session: 0e61c749-26a1-4e90-94e7-cfa33d17e5ef
Copilot AI review requested due to automatic review settings July 14, 2026 15:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the docs site’s Getting Started evaluation manifest so it includes an explicit executor setting, ensuring the example eval.yaml conforms to the expected schema and runs without requiring API access.

Changes:

  • Add config.executor: mock to the Getting Started eval.yaml example.
Show a summary per file
File Description
site/src/content/docs/getting-started.mdx Adds executor: mock to the sample eval manifest under config so copied starter manifests are schema-valid.

Review details

  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Low

@spboyer
spboyer merged commit 4b6d158 into main Jul 14, 2026
9 checks passed
@spboyer
spboyer deleted the spboyer-fix-getting-started-manifest branch July 14, 2026 15:20
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.

Docs: Getting Started eval.yaml example is missing required executor property

3 participants