Skip to content

docs: add .preflight/ example config files with annotations - #92

Closed
TerminalGravity wants to merge 1 commit into
mainfrom
docs/preflight-config-examples-v2
Closed

docs: add .preflight/ example config files with annotations#92
TerminalGravity wants to merge 1 commit into
mainfrom
docs/preflight-config-examples-v2

Conversation

@TerminalGravity

Copy link
Copy Markdown
Collaborator

Adds ready-to-copy example configs in examples/.preflight/ with detailed comments explaining every option. Updates README Configuration Reference to point to these templates.

Users can now:

cp -r /path/to/preflight/examples/.preflight .preflight

Files added:

  • examples/.preflight/config.yml — profile, related projects, thresholds, embeddings
  • examples/.preflight/triage.yml — strictness, always_check, skip, cross_service keywords

Added examples/.preflight/config.yml and triage.yml with detailed
comments explaining every option. Added quick-copy instructions
to the Configuration Reference section in README.
@TerminalGravity

Copy link
Copy Markdown
Collaborator Author

Annotated example configs are a nice DX win — lowers onboarding friction. Comments are clear, defaults sensible. Ready to merge. Note: #87 appears to be an earlier version of this — can be closed.

@TerminalGravity

Copy link
Copy Markdown
Collaborator Author

Nice — annotated configs are way better for onboarding. The example triage.yml with always_check/skip lists is a great starting point. LGTM, just needs a review to merge.

@TerminalGravity

Copy link
Copy Markdown
Collaborator Author

Superseded by #118/#114.

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