Skip to content

add .preflight.example/ config templates#194

Closed
TerminalGravity wants to merge 1 commit intomainfrom
chore/preflight-config-example
Closed

add .preflight.example/ config templates#194
TerminalGravity wants to merge 1 commit intomainfrom
chore/preflight-config-example

Conversation

@TerminalGravity
Copy link
Collaborator

Adds a ready-to-copy example config directory with annotated config.yml, triage.yml, and contracts/api.yml. README now links to it from the Configuration Reference section.

Includes annotated config.yml, triage.yml, contracts/api.yml, and a
README explaining how to use them. The main README now links to the
example directory from the Configuration Reference section.
Copy link
Collaborator Author

@TerminalGravity TerminalGravity left a comment

Choose a reason for hiding this comment

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

Nice onboarding addition. The annotated config + triage + contracts example will save people a lot of guesswork.

Quick notes:

  • #190 covers similar ground — if this is the refined version, let's close #190 to avoid confusion.
  • Might be worth adding a one-liner to the example README about cp -r .preflight.example .preflight as the quickstart step.
  • The contracts/api.yml example is a great touch — that's probably the least obvious part of the config.

@TerminalGravity
Copy link
Collaborator Author

Superseded by #196 which uses examples/.preflight/ (cleaner location). Closing duplicate.

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