docs: add .preflight/ example config files - #87
Closed
TerminalGravity wants to merge 2 commits into
Closed
Conversation
Covers common issues: LanceDB native modules, first-run model download, missing session data, .preflight/ config not loading, tools not appearing in Claude Code, and permission errors.
Adds copyable example files for config.yml, triage.yml, and contracts/api.yml so users can quickly set up project-level configuration without reading the full README.
TerminalGravity
commented
Mar 4, 2026
TerminalGravity
left a comment
TerminalGravity
left a comment
Collaborator
Author
There was a problem hiding this comment.
The .example pattern is much better than expecting people to reverse-engineer config from source. Comments in each file are helpful without being verbose.
One thought: mention the .preflight/ directory in the README quickstart section too — new users scanning the README won't know to look there until they've already hit a wall.
Good to merge.
Collaborator
Author
|
Superseded by #92 (annotated version). Closing. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds copyable .example files for config.yml, triage.yml, and contracts/api.yml plus a README explaining the directory. Users can
cp *.exampleto get started without reading the full README.