docs: add CHANGELOG.md with version history#38
Closed
TerminalGravity wants to merge 4 commits intomainfrom
Closed
Conversation
… and contracts The README references .preflight/ config extensively but there were no concrete example files to copy. This adds a ready-to-use examples/.preflight/ directory with annotated config.yml, triage.yml, and contracts/api.yml, plus a README explaining how to use them.
Created examples/USAGE_EXAMPLES.md with 8 real-world scenarios showing what each tool looks like in practice: preflight_check catching vague prompts, scope_work creating execution plans, enrich_agent_task for sub-agents, sharpen_followup resolving ambiguity, session health checks, semantic history search, weekly scorecards, and prompt grading. Added link to usage examples in README nav bar.
TerminalGravity
commented
Feb 28, 2026
Collaborator
Author
TerminalGravity
left a comment
TerminalGravity
left a comment
There was a problem hiding this comment.
CHANGELOG looks great — covers all the major releases with the right level of detail. The link refs at the bottom are a nice touch.
Two things:
-
Overlap with #36 and #37 — this PR includes the troubleshooting section and the Usage Examples nav link, which are also in those PRs. You'll hit merge conflicts if any of them land first. Suggest rebasing this onto whichever lands first, or consolidating the README changes into one PR.
-
The 2.x entry —
2025-01-xxas a date looks placeholder-ish. Either pin it to an approximate date or just sayEarly 2025without the bracket format since it wasn't a formal release anyway.
Otherwise solid — ship it after sorting out the rebase order.
Collaborator
Author
|
Superseded by newer PRs. |
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 a CHANGELOG.md covering v3.0.0 through v3.2.0 with categorized changes (Added/Fixed/Improved/Breaking). Also links it from the README nav bar.